ci: add NEWS.md entry check for chart version bumps#798
Open
astayleraz wants to merge 2 commits intomainfrom
Open
ci: add NEWS.md entry check for chart version bumps#798astayleraz wants to merge 2 commits intomainfrom
astayleraz wants to merge 2 commits intomainfrom
Conversation
Add a CI check that verifies changed charts with a version bump also have a corresponding heading in NEWS.md. This prevents changelog entries from being forgotten when releasing chart updates. The check runs on PRs only (not main) and complements the existing chart-testing version bump requirement — if ct lint already requires a version bump for every chart change, then every bump should have a changelog entry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…TING.md - Add NEWS.md requirement to CONTRIBUTING.md under "Assumptions / Common Dev Workflows" so contributors know about it before hitting CI - Improve the error message to show the version diff and an example of what to add Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
tools/dev/check-news-entries.sh— verifies that charts with a version bump have a corresponding## X.Y.Zheading inNEWS.mdtestjob to run this check on PRsMotivation
Every chart change already requires a version bump (enforced by
ct lint). But there's no check that the bump has a changelog entry inNEWS.md, so it's easy to forget. This happened in #795 and was caught manually after merge.The check is simple: for each chart directory, compare the
Chart.yamlversion againstorigin/main. If it changed, verifyNEWS.mdcontains a## <version>heading. Runs on PRs only (skipped on main pushes since the version is already released at that point).How it works
Test plan
🤖 Generated with Claude Code