Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove empty changelog sections when creating changelog from Keep A Changelog format #63

Closed
weierophinney opened this issue Sep 3, 2020 · 0 comments · Fixed by #68
Closed

Remove empty changelog sections when creating changelog from Keep A Changelog format #63

weierophinney opened this issue Sep 3, 2020 · 0 comments · Fixed by #68
Assignees
@weierophinney
Labels
Feature Request
Milestone
1.6.0

Comments

@weierophinney
Copy link
Member

Feature Request

Q A
New Feature improvement
RFC no
BC Break no

Summary

Currently when using Keep A Changelog-formatted changelogs, it's not uncommon to have entries that look like this:

## X.Y.Z - TBD

### Added

- Nothing.

### Changed

- Nothing.

### Removed

- Nothing.

### Deprecated

- Nothing.

### Fixed

- Something we fixed

This leads to a lot of noise in the generated changelogs, as we have a lot of "Nothing" entries, followed by a list of things we actually did.

The suggested improvement is to find ### {heading}\n\nNothing.\n entries and remove them as part of changelog fetching and normalization.
@weierophinney weierophinney self-assigned this Sep 3, 2020
weierophinney added a commit to weierophinney/automatic-releases that referenced this issue Sep 3, 2020
@weierophinney
fix: end changelog version entry with empty line
709d99c 
Append an empty line to the changelog entry when writing it to the
changelog file, to ensure there's an empty line above the next version
entry.

Fixes laminas#63

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
@weierophinney weierophinney mentioned this issue Sep 3, 2020
Merged
weierophinney added a commit to weierophinney/automatic-releases that referenced this issue Sep 3, 2020
@weierophinney
feat: strip empty sections from keep-a-changelog release notes
7f82195 
Instead of only looking for and removing "default contents" (i.e., what
is generated via keep-a-changelog `bump*` operations), this patch looks
for any of the default sections that have the "- Nothing" default
contents and removes them.

Fixes laminas#63

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
@weierophinney weierophinney mentioned this issue Sep 3, 2020
Merged
@Ocramius Ocramius added this to the 1.6.0 milestone Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@weierophinney weierophinney

Labels
Feature Request
Projects
None yet
Milestone
1.6.0
Development

Successfully merging a pull request may close this issue.

Strip empty sections from keep-a-changelog release notes weierophinney/automatic-releases
2 participants
@weierophinney @Ocramius