Fix 2.20.0 notes gap + make curated notes obligatory for stable releases#243
Merged
Conversation
The 2.20.0 tag was cut without planning/releases/2.20.0.md, so release.yml fell back to GitHub's auto-generated PR list instead of curated notes. Add the missing notes file (Group.get_named_providers()) to match every release since 2.15.0 and restore the GitHub Release body to the curated form. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a guard step before `just publish` that fails the release when a stable tag has no planning/releases/<tag>.md. PyPI is irreversible and runs first, so the check gates it: a missing notes file now aborts before anything ships, instead of silently falling back to GitHub's auto-generated notes (which is how 2.20.0 went out). Pre-release tags (e.g. 2.0.0rc1) stay exempt and keep the auto-generated fallback. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
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.
What
Two commits closing the same gap and preventing recurrence:
docs(release): add 2.20.0 notes— adds the missingplanning/releases/2.20.0.md. Covers the one feature in 2.20.0,Group.get_named_providers()(feat: add Group.get_named_providers() #242); the rest of the tag range is planning/CLAUDE.md/CI chores with no API change.ci(release): require curated notes for stable tags— adds a guard step inrelease.ymlbeforejust publishthat fails the release if a stable tag has noplanning/releases/<tag>.md.Why
The
2.20.0tag was cut without a curated notes file, sorelease.ymlhit its fallback (generate_release_notes: true) and published the GitHub Release with GitHub's auto-generated PR list — the only release since 2.15.0 missing curated notes.Because PyPI publish is irreversible and runs first, the guard runs before it: a missing notes file now aborts the release before anything ships, instead of silently degrading to auto-generated notes. Pre-release tags (e.g.
2.0.0rc1) stay exempt and keep the fallback.Follow-up (manual, outward-facing)
The live 2.20.0 GitHub Release body still shows the auto-generated notes. After merge, restore it from the curated file:
Nothing to do on PyPI — that publish is irreversible and already correct.
🤖 Generated with Claude Code