8000 Change the format for changelog entries · yorickpeterse/clogs@98d4180 · GitHub
[go: up one dir, main page]

Skip to content

Commit

Permalink
Change the format for changelog entries
Browse files Browse the repository at this point in the history
Instead of showing the SHA for each commit, we now only show the subject
as a link, making the list of changes a little nicer to read when
rendered to HTML. So instead of this:

    - [SHA](URL): SUBJECT

The format is now this:

    - [SUBJECT](URL)

Changelog: changed
  • Loading branch information
yorickpeterse committed Oct 28, 2024
1 parent ad983cf commit 98d4180
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
3 changes: 1 addition & 2 deletions src/clogs/changelog.inko
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,8 @@ impl ToString for Release {

commits.iter.each(fn (c) {
let url = @config.url.replace('%s', c.id)
let short = c.id.slice(start: 0, size: 7)

markdown.push('\n- [${short}](${url}): ${c.subject}')
markdown.push('\n- [${c.subject}](${url})')
})
})

Expand Down
16 changes: 8 additions & 8 deletions test/clogs/test_changelog.inko
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ fn pub tests(t: mut Tests) {

### Added

- [1234567](a/1234567890): a
- [0987654](a/0987654321): b
- [a](a/1234567890)
- [b](a/0987654321)

### Fixed

- [6789054](a/6789054321): c',
- [c](a/6789054321)',
)
})

Expand Down Expand Up @@ -107,7 +107,7 @@ fn pub tests(t: mut Tests) {

### Added

- [1234567](a/1234567890): a
- [a](a/1234567890)
',
)
})
Expand All @@ -129,7 +129,7 @@ fn pub tests(t: mut Tests) {

### Added

- [1234567](a/1234567890): a
- [a](a/1234567890)
',
)
})
Expand All @@ -151,7 +151,7 @@ fn pub tests(t: mut Tests) {

### Added

- [1234567](a/1234567890): a
- [a](a/1234567890)
',
)
})
Expand Down Expand Up @@ -180,7 +180,7 @@ Foo',

### Added

- [1234567](a/1234567890): a
- [a](a/1234567890)

## 1.0.0 (2023-08-01)

Expand Down Expand Up @@ -210,7 +210,7 @@ Foo',

### Added

- [1234567](a/1234567890): a
- [a](a/1234567890)

## 1.0.0 (2023-08-01)

Expand Down

0 comments on commit 98d4180

Please sign in to comment.
0