CI: Check versioned release notes exist before releasing#1907
Open
cpcloud wants to merge 3 commits intoNVIDIA:mainfrom
Open
CI: Check versioned release notes exist before releasing#1907cpcloud wants to merge 3 commits intoNVIDIA:mainfrom
cpcloud wants to merge 3 commits intoNVIDIA:mainfrom
Conversation
Add a check-release-notes job to the release workflow that verifies the versioned release-notes file (e.g. 13.1.0-notes.rst) exists and is non-empty for each package being released. The job blocks doc, upload-archive, and publish-testpypi via needs: gates. Helper script at toolshed/check_release_notes.py parses the git tag, maps component to package directories, and checks file presence. Post-release tags (.postN) are silently skipped. Tests cover tag parsing, component mapping, missing/empty detection, and the CLI. Refs NVIDIA#1326 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Ensures the release-notes check validates the tagged tree, not the default branch HEAD. Without this, manually triggered runs could validate the wrong commit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <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
check-release-notesjob to the release workflow that verifies the versioned release-notes file (e.g.13.1.0-notes.rst) exists and is non-empty for each package being releaseddoc,upload-archive, andpublish-testpypijobs vianeeds:gates so releases cannot proceed with missing notes.postNtags are silently skipped (no notes file expected)toolshed/check_release_notes.pywith 20 pytest testsTest plan
check-release-notesjob runs in CI on a test release dispatch.postNtags skip without failureCloses #1326
🤖 Generated with Claude Code