Open
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new GitHub Actions workflow to enforce that the CHANGELOG.md file is updated with a new version before merging to main, preventing version mismatches on release.
- Established a version bump check using a third-party action.
- Configured the workflow to run on pull requests targeting the main branch.
Contributor
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
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.
Proposed changes
To avoid failures where the version in
mainis not updated and the release version then does not match, enforce a rule that theCHANGELOG.mdmust contain an updated version before merging tomain. If the version inCHANGELOG.mdonmainis already higher than the previous release, the Action will pass.Type of Change
Production
Development
Video
Example workflow failure due to version mismatch:
Example of this check running:
Example where no
CHANGELOG.mdexists onmainChecklist
Further comments