[CHORE]: Add CI workflow to make sure changelog gets updated with every PR - #5724
Merged
Conversation
camdecoster
reviewed
Sep 10, 2026
camdecoster
left a comment
camdecoster
left a comment
Contributor
There was a problem hiding this comment.
Great idea! I left a few comments that I think will improve the check.
| jobs: | ||
| check-changelog: | ||
| name: Check if CHANGELOG.md was updated | ||
| if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog') }} |
Contributor
There was a problem hiding this comment.
Could you add a message for the skipped and success cases? Also, could you also skip if the PR is in a draft state?
Co-authored-by: Cameron DeCoster <cameron.decoster@gmail.com>
camdecoster
approved these changes
Sep 10, 2026
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
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.
Link to issue
Closes #5723
Description of change
Add a CI job to check that
CHANGELOG.mdis updated for every PR, unless theno-changeloglabel is added to the PR.This implementation is pretty naïve; it only checks that
CHANGELOG.mdhas been modified, not whether the new entry follows the correct format. Feel free to complexify in the future.Demo
❌ Run failed (
CHANGELOG.mdnot updated):https://github.com/plotly/plotly.py/actions/runs/34384286059/job/102576548616
⚪ Run skipped (
no-changeloglabel added):https://github.com/plotly/plotly.py/actions/runs/34384435370/job/102577056340?pr=5724
✅ Run passed (
CHANGELOG.mdupdated with dummy entry for demo purposes):https://github.com/plotly/plotly.py/actions/runs/34385144520/job/102579417311?pr=5724
Guidelines