Changelog Automation for Squash and Merge commit messages #28747
+264
−0
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.
Community Note
Description
Adding the GitHub actions and the go script for the changelog automation.
When a PR is merged using squash and merge, the text from the body of the squash and merge is checked for a changelog entry.
It is checking for [BUG], [ENHANCEMENT], or [FEATURE]. Breaking changes need to be added to the changelog manually.
The automation will add the [GH-12345] to the end of the entry.
The automation will check if a PR is already open for the next release. If one is open, it will add the entry under the first matching header. If a PR is not already open, it will open a PR on a branch called
automated-changelog
, update the headers, and add the new entry. It does NOT currently add entries/sort entries in alphabetical order, that is a future enhancement.PR Checklist
For example: “
resource_name_here
- description of change e.g. adding propertynew_property_name_here
”This is a (please select all that apply):
Note
If this PR changes meaningfully during the course of review please update the title and description as required.