Improve sections ordering #139
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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:
- Security
- Changed
- Removed
- Deprecated
- Added
- Fixed
- Other
|
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. |
The reordering cause extra new lines to be output in existing changelogs. Make the template consistent accross each section to fix the issue.
|
@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
approved these changes
Sep 30, 2023
|
Thank you! I will cut a new release later today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: