add: workflow to assert changelog updates #2675
Merged
Conversation
This file contains hidden or 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
carsakiller
added
the
documentation
Collaborator
Author
|
GitHub's documentation on what values are available in a pull request workflow is not the greatest. I'm not sure if it now only works for pushes to pull requests and will always fail upon the first opening of a pull request… but I won't know until it fails. I would not be surprised if this false-fails on the next PR, but just |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a workflow that checks incoming PRs for changelog changes, failing if no changes were made.
Another important change is that the changelog should always contain an “Unreleased” section at the top, so it is easy to add all new changes there between releases. When it is time for a new release, the points from under “Unreleased” are simply moved under a version number.
This should help prevent new changes from going under the radar.
@sumneko I have also edited the branch protection rules on
masterso that in order for a pull request to be merged, this changelog edit check must succeed before merging, although admins can still override it and merge regardless.