Repository navigation
docs(release): Describe the auto-versioned release flow - #166
Merged
Merged
Conversation
The README still told releasers to pick a bump type and named action-prepare-release, so following it would skip the version craft derives from PR titles and miss the breaking-change check that made 2.0.0 a major release. It now explains that PR titles drive the version and changelog, what the workflow and publish issue produce, and how to retract a request, which we had to do for the first auto release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getsentry/pypi#2639 made its build skip Python versions excluded by a package's Requires-Python, so the python_versions line no longer has to be added by hand. The 2.0.0 PR merged without it and its build skipped 3.11 and 3.12 on its own. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Retracting a publish request works the same for every repository using getsentry/publish, so it doesn't belong in this README. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
giovanni-guidini
approved these changes
Oct 26, 2026
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
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
The README's release steps date from before #163–#165. They tell you to pick a bump type, say the version comes from
pyproject.toml, and namegetsentry/action-prepare-release. Following them skips craft'sautoversioning, so a breaking PR could ship as a minor release.Approach
Update the "Releasing a New Version" steps to match the current workflow:
auto, and how PR titles map to major/minor/patch, with the explicit bump types kept as overrides;release/<version>branch, theCHANGELOG.mdsection, and the publish issue to check;main;!for breaking changes.The manual
getsentry/pypistep, addingpython_versions = >=3.13to its PR, is removed. Since getsentry/pypi#2639, that repository's build skips Python versions excluded by a package'sRequires-Python. The 2.0.0 PR (getsentry/pypi#2669) merged without the line, and its build skipped 3.11 and 3.12 on its own.🤖 Generated with Claude Code