ci: add GitHub Action to check CHANGELOG consistency with PRs #12347
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
LiteSun
commented
Jun 18, 2025
| 'ci' | ||
| ]; | ||
|
|
||
| const IGNORE_PRS = [ |
dosubot
bot
added
size:L
LiteSun
requested review from
Baoyuantop,
SkyeYoung,
bzp2010,
juzhiyuan and
membphis
SkyeYoung
reviewed
Jun 19, 2025
SkyeYoung
reviewed
Jun 19, 2025
ci/check_changelog_prs.ts
Outdated
| } | ||
| } | ||
|
|
||
| main(); |
SkyeYoung
previously approved these changes
Jun 20, 2025
Baoyuantop
reviewed
Jun 20, 2025
juzhiyuan
previously approved these changes
Jun 20, 2025
| name: Check Changelog | ||
|
|
||
| on: | ||
| push: |
There was a problem hiding this comment.
I'm wondering if we should just listen for changes in the CHANGEsLOG file?
There was a problem hiding this comment.
I'm wondering if we should just listen for changes in the CHANGEsLOG file?
we actually need to detect any missing changelog updates as early as possible when a PR is created. I just tested it and found that the push event does not trigger the CI when the PR is first submitted.
SkyeYoung
approved these changes
Jun 20, 2025
Baoyuantop
approved these changes
Jun 20, 2025
juzhiyuan
approved these changes
Jun 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Description
This PR provides a script to check the changelog for completeness. If a PR is not of type docs, chore, test, or ci, and is not listed in the IGNORE_PRS variable, but is missing from the changelog, the script will raise an error.
Note: This script currently only checks changelog entries for versions after 3.8.0.
Test record:
Which issue(s) this PR fixes:
Checklist