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.

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

Strip empty sections from keep-a-changelog release notes #68

Conversation

weierophinney
Copy link
Member

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 #63

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 added this to the 1.6.0 milestone Sep 3, 2020
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but need @michalbundyra to skim over this first

@weierophinney
Copy link
Member Author

@michalbundyra There will still be some redundancy between stuff in the main changelog and the generated contents, but the former will give user-focused context that the latter does not. What this patch does, however, is remove the verbosity of that "Nothing" boilerplate, which should make this look better.

The fixes for #64 address the rest of it, which is redundancy in headings and whatnot introduced by the release notes generator. The combination of the the two should give us something you're more comfortable with.

Copy link
Member

@michalbundyra michalbundyra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@Ocramius Ocramius merged commit 763195a into laminas:1.6.x Sep 3, 2020
@weierophinney weierophinney deleted the hotfix/63-remove-empty-changelog-sections branch September 3, 2020 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove empty changelog sections when creating changelog from Keep A Changelog format
3 participants