search

chelnak / gh-changelog

A gh cli extension that will make your changelogs ✨
MIT License
114 stars 4 forks source link

Improve sections ordering #139

Closed smortex closed 1 year ago

smortex commented 1 year ago

In order to better match changes that follow semver, group changes that trigger a MAJOR bump ("Changed", "Removed") before those that trigger a MINOR bump ("Added"), before those that trigger a PATCH bump ("Fixed").

"Security", "Deprecated" and "Other" changes do not have a corresponding part as far as semver is concerned, so put them where it makes more sense: "Security" at the top, "Deprecated" just after "Removed" and "Other" at the end.

The ordering is now:

chelnak commented 1 year ago

Looks good! Thank you for the improvement. 🙏

Did you get chance to test it? If not I can validate a bit later and cut a release.

smortex commented 1 year ago

@chelnak I added a commit to fix some inconsistency in the template that caused changes when generating the changelog for the project itself. It now produce the same changelog as before.

I also tried it on the puppetlabs-apache module and the new changelog only change by section ordering as expected.

chelnak commented 1 year ago

Thank you! I will cut a new release later today.