chore: Update CHANGELOG implementation #2470
Merged
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.
Description
This PR updates the CHANGELOG and release notes generation process and layout:
CHANGELOG.md
Closes
orFixes
pattern matching)CHANGELOG.md
will not include issue references in outputBREAKING:
in commit message bodyCloses: #2467
Signed-off-by: Michael Gasch mgasch@vmware.com
Example of rendered Release Notes
Release v0.26.0
🐞 Fix
💡 Examples
💫
govc
(CLI)💫
vcsim
(Simulator)📃 Documentation
Example highlighting Breaking Changes
remove ctx from param
Type of change
Please mark options that are relevant:
not work as expected)
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. If applicable, please also list any relevant
details for your test configuration.
Test Configuration:
Checklist:
this project