Skip to content

docs: update release instructions in CONTRIBUTING.md #49

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
FBumann merged 1 commit into from
Mar 9, 2026
Merged

docs: update release instructions in CONTRIBUTING.md #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,8 @@ uv run ruff format .

## Releases

Releases are automated via GitHub Actions. Version is determined from git tags via setuptools_scm.
Releases are fully automated via [Release Please](https://github.com/googleapis/release-please).

To create a release:

1. Tag: `git tag v0.1.0`
2. Push: `git push && git push --tags`

The CI will automatically publish to PyPI and deploy updated docs.
1. Merge PRs to `main` using [conventional commit](https://www.conventionalcommits.org/) prefixes (`feat:`, `fix:`, etc.)
2. Release Please automatically creates/updates a release PR with changelog and version bump
3. Merge the release PR to publish to PyPI and deploy updated docs