馃敡 Handle release-note failures without blocking releases - #361
Closed
Robdel12 wants to merge 2 commits into
Closed
Conversation
Stop publishing when note generation fails, allow prepared Markdown through workflow dispatch, and ask for concrete migration guidance.
Warn and publish a changelog link when generation fails. Keep automatic copy concise and allow prepared notes without making them a release requirement.
Robdel12
changed the title
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.
Why
Release-note generation for v0.36.0 failed because the API account had no credits. The release still published, but its notes became a raw commit list without migration guidance.
Approach
Keep generation optional for publication. If it fails or produces blank notes, warn in the workflow log and summary, discard partial output, and publish with a changelog link. Prepared Markdown can be supplied through the optional
release_notesinput to skip generation.The prompt asks for short, factual notes and concrete migration steps. Pass the notes file directly to the release action to preserve Markdown without multiline output delimiters.
Evidence
Ten local workflow checks cover generated and manual notes, missing and blank output, and partial output from failed generation, with and without a previous tag. All cases allow publication and select the expected notes. The full CLI suite passed: 1,930 tests, with five skipped.
Automatic generation still requires replenishing API credits. This PR keeps that failure from blocking a release; it does not fix account billing.