Skip to content

allow unreleased CHANGELOG section if all subsections are empty#128

Merged
jgravois merged 4 commits into
ungoldman:masterfrom
leviathan747:empty-unreleased-subsections
May 18, 2021
Merged

allow unreleased CHANGELOG section if all subsections are empty#128
jgravois merged 4 commits into
ungoldman:masterfrom
leviathan747:empty-unreleased-subsections

Conversation

@leviathan747

Copy link
Copy Markdown
Contributor

My team likes to keep the 6 subsection headings from keepachangelog in CHANGELOG.md that way we don't have to remember the categories. This change only prevents the release if there are any bullets in any of the subsections.

@jgravois jgravois left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

thanks for this contribution @leviathan747! i think its a handy change and the code comment below seems to indicate that you're implementing the intended behavior.

https://github.com/hypermodules/gh-release/blob/260fedd67a68b04439b0558bbd6f827b519da0e9/bin/lib/get-defaults.js#L29

if you can add another fixture and test, we should be able to get this PR landed.

example:
https://github.com/hypermodules/gh-release/blob/260fedd67a68b04439b0558bbd6f827b519da0e9/test/get-defaults-test.js#L40-L47

https://github.com/hypermodules/gh-release/tree/260fedd67a68b04439b0558bbd6f827b519da0e9/test/fixtures/stringy-repo

@leviathan747

leviathan747 commented May 18, 2021

Copy link
Copy Markdown
Contributor Author

@jgravois ready for final review

Quick question: what's the release schedule of this project? When could I expect to see this change in a release version?

@jgravois jgravois left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i added one more test in 20b9a8e. thanks again @leviathan747!

if i have the 🔑s, i'll publish this as a patch forthwith.

@jgravois jgravois merged commit 187911d into ungoldman:master May 18, 2021
@jgravois

Copy link
Copy Markdown
Collaborator

v5.0.1 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants