ci(release): tolerate missing changelog section in dry-run#171
Merged
Conversation
In dry-run from the orchestrator's fresh-bump path, the projected tag (e.g. v0.25.0) has no changelog section yet because commitizen only writes it during the real bump. Emit a placeholder body instead of failing so the dry-run summary still renders. Real releases still fail fast on missing sections.
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.
Problem
Post-merge validation of the new release pipeline surfaced a real bug in dry-run mode. Run 26253881223 (fresh-bump dry-run) failed at the
releasejob because the projected tagv0.25.0has no section indocs/source/changelog.md— commitizen only writes it during the real bump.Fix
In
release.yaml'sExtract changelog sectionstep: if the section is empty AND we're in dry-run, emit a placeholder body so the dry-run summary still renders. Real releases continue to fail fast on missing sections.Validation context
The recovery-path dry-run (26253886867) passed end-to-end (all 16 wheel builds, sdist, attestation,
uv publishdry-run, merge dry-run summary) sincev0.24.1has a real changelog section. This fix lets the fresh-bump dry-run reach the wheel matrix too.Test plan
Release pipelinewithincrement=auto, dry_run=trueand confirmreleasesucceeds with the placeholder body in the step summary.