Skip to content

Repository navigation

docs(release): Describe the auto-versioned release flow #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vaind merged 3 commits into from
Oct 26, 2026
Merged

docs(release): Describe the auto-versioned release flow #166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f85e69c
docs(release): Describe the auto-versioned release flow
vaind Oct 26, 2026
c4798aa
docs(release): Drop the manual getsentry/pypi edit
vaind Oct 26, 2026
34da713
docs(release): Drop the retract instructions
vaind Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ We have extensive documentation both inline in the Sentry codebase and on the [S

1. On the `getsentry/scm-platform` repository page click the **Actions** tab.
2. On the left-hand side click the **release** workflow.
3. Click **Run workflow**, choose a bump type (`patch`, `minor`, or `major`), and run it. The next version is calculated automatically from the current version in `pyproject.toml`.
4. The workflow will create a release branch and PR via `getsentry/action-prepare-release`. After completion it will return a URL to an issue on `getsentry/publish`.
5. On the `getsentry/publish` issue immediately set the **accepted** label.
6. A pull request will be opened on `getsentry/pypi`.
7. Edit the file in GitHub and place `python>=3.13` on the line immediately following the changed line.
8. The PR will merge automatically. When it's merged your new version is available for use.
3. Click **Run workflow** and run it with the default bump type, `auto`. [Craft](https://github.com/getsentry/craft) picks the version from the titles of the PRs merged since the last release tag: `type!:` (e.g. `fix!:`) makes a major release, `feat:` a minor one, and any other conventional-commit type a patch. Choose `major`, `minor`, or `patch` only to override it.
4. The workflow creates a `release/<version>` branch with the version bump and the new `CHANGELOG.md` section, and opens an issue on `getsentry/publish` titled `publish: getsentry/scm-platform@<version>`. Check that the version and changelog in the issue are what you expect.
5. On the `getsentry/publish` issue set the **accepted** label. Once CI passes on the release branch, Craft publishes to PyPI and the internal `getsentry/pypi` index, creates the GitHub release with the same changelog, and merges the release branch into `main`.
6. A pull request adding the version to `getsentry/pypi` is opened and merged automatically. Once it's merged and that repository's build finishes, the new version is available for use.

Because the changelog and version come from PR titles, give every PR a [conventional-commit](https://www.conventionalcommits.org/) title, and mark breaking changes with `!`.
Loading