actions: add CHANGELOG validation script #13
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
ginglis13
reviewed
Dec 23, 2024
.github/workflows/build.yml
Outdated
| @@ -53,4 +53,5 @@ jobs: | |||
| - run: make twoliter check-fmt | |||
| - run: make twoliter check-clippy | |||
| - run: make twoliter check-shell | |||
| - run: ./tools/validate-changelog.sh | |||
There was a problem hiding this comment.
this action will ignore changes made solely to markdown files (L13), so if someone were to make a change that only edits the CHANGELOG, this check wouldn't run
There was a problem hiding this comment.
oh, good catch, thanks! I'll add a new workflow for validating markdown changes then
Signed-off-by: Sam Berning <[email protected]>
sam-berning
force-pushed
the
validate-changelog
branch
from
64e4208 to
beedacf
Compare
cbgbt
approved these changes
Dec 23, 2024
ginglis13
approved these changes
Dec 23, 2024
rpkelly
approved these changes
Dec 23, 2024
larvacea
approved these changes
Dec 23, 2024
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.
Issue number:
Closes #
Description of changes:
Adds some rudimentary CHANGELOG validation to the build action that runs on PRs. This should ensure that we don't merge a CHANGELOG that can't be parsed by the release CI.
Testing done:
Tested script locally. Against current CHANGELOG:
$ ./tools/validate-changelog.sh CHANGELOG validation PASSED!Against the CHANGELOG with a "v" removed from a version header:
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.