Skip to content

Add .github/release.yaml and update RELEASE.md instructions #231

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
stefanvanburen merged 1 commit into from
Apr 29, 2026
Merged

Add .github/release.yaml and update RELEASE.md instructions #231

Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions .github/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
changelog:
exclude:
labels:
- ignore-for-release
authors:
- renovate[bot]
10 changes: 4 additions & 6 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,25 @@ This document outlines how to create a release of connect-python.
2. On a new branch, update version strings with the `bump` command, either to the next minor or patch version, based on the changes that are included in this new release.

- If there are only bug fixes and no new features, run `uv run poe bump --version patch`.
- If there are features being released, run `uv run poe bump --version minor`.
- If there are features being released (or breaking changes being made while we're pre-1.0 release), run `uv run poe bump --version minor`.

Note the new version X.Y.Z in the updated files.

3. Open a PR titled "Prepare for vX.Y.Z" ([Example PR #60](https://github.com/connectrpc/connect-python/pull/60)) and assign the `connectrpc/python` group as reviewers. Once it's approved by at
3. Open a PR titled "Prepare for vX.Y.Z" ([Example PR: #60](https://github.com/connectrpc/connect-python/pull/60)) and assign the `connectrpc/python` group as reviewers. Once it's approved by at
least one other maintainer and CI passes, merge it.

_Make sure no new commits are merged until the release is complete._

4. Review all commits in the new release and for each PR check an appropriate label is used and edit the title to be meaningful to end users.

5. Using the Github UI, create a new release.
5. Using the GitHub UI, create a new release.

- Under “Select tag”, type in “vX.Y.Z” to create a new tag for the release upon publish.
- Target the main branch.
- Title the Release “vX.Y.Z”.
- Click “set as latest release”.
- Set the last version as the “Previous tag”.
- Click “Generate release notes” to autogenerate release notes.
- Edit the release notes. A summary and other categories should be added, in most cases, with the two categories ### Enhancements and ### Bugfixes. Feel free to collect multiple small changes to docs or Github config into one line, but try to tag every contributor. Make especially sure to credit new external contributors!
- Edit the release notes. A summary and other categories should be added, in most cases, with the two categories ### Enhancements and ### Bugfixes. Feel free to collect multiple small changes to docs or GitHub config into one line, but try to tag every contributor. Make especially sure to credit new external contributors!

6. Publish the release.

[latest release]: https://github.com/connectrpc/connect-python/releases/latest
Loading