Skip to content

[CHORE]: Add CI workflow to make sure changelog gets updated with every PR - #5724

Open
emilykl wants to merge 4 commits into
mainfrom
add-changelog-check
Open

[CHORE]: Add CI workflow to make sure changelog gets updated with every PR#5724
emilykl wants to merge 4 commits into
mainfrom
add-changelog-check

Conversation

@emilykl

@emilykl emilykl commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Link to issue

Closes #5723

Description of change

Add a CI job to check that CHANGELOG.md is updated for every PR, unless the no-changelog label is added to the PR.

This implementation is pretty naïve; it only checks that CHANGELOG.md has been modified, not whether the new entry follows the correct format. Feel free to complexify in the future.

Demo

❌ Run failed (CHANGELOG.md not updated):
https://github.com/plotly/plotly.py/actions/runs/34384286059/job/102576548616

⚪ Run skipped (no-changelog label added):
https://github.com/plotly/plotly.py/actions/runs/34384435370/job/102577056340?pr=5724

✅ Run passed (CHANGELOG.md updated with dummy entry for demo purposes):
https://github.com/plotly/plotly.py/actions/runs/34385144520/job/102579417311?pr=5724

Guidelines

@emilykl emilykl added the no-changelog A changelog entry is not required for this PR label Sep 9, 2026
@emilykl emilykl removed the no-changelog A changelog entry is not required for this PR label Sep 9, 2026
@emilykl emilykl added the no-changelog A changelog entry is not required for this PR label Sep 9, 2026
@emilykl
emilykl requested a review from camdecoster September 9, 2026 17:54
@camdecoster camdecoster self-assigned this Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog A changelog entry is not required for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CHORE]: Add CI step to check for changelog update

2 participants