Skip to content

docs: add RELEASING.md #146

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
nielspardon merged 3 commits into from
Jan 15, 2026
Merged

docs: add RELEASING.md #146

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11251d9
docs: add RELEASING.md
nielspardon Jan 15, 2026
df167bc
docs: apply feedback
nielspardon Jan 15, 2026
c31e577
docs: add section about versioning
nielspardon Jan 15, 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
14 changes: 14 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Releasing substrait-python

Given that you are a Substrait committer or PMC member and have the appropriate permissions, releasing a new version of substrait-python is done by simply creating new Github Release through the UI:

1. Go to https://github.com/substrait-io/substrait-python/releases
2. Click `Draft a new release`
3. Enter the version to be released in the `Tag` field prefixed with a lower case `v`, e.g. `v0.99.0`. Then click `Create new tag` which tells Github to create the tag on publication of the release.
4. Click `Generate release notes` which will automatically populate the release title and release notes fields.
5. If you are happy with the release notes and you are ready for an immediate release simply click `Publish release` otherwise save the release as a draft for later.
6. Monitor the Github Actions release build for the newly created release and tag.

## Versioning

substrait-python follows semantic versioning as described for the Substrait specification here: https://substrait.io/spec/versioning/.