|
| 1 | +# Releasing connect-python |
| 2 | + |
| 3 | +This document outlines how to create a release of connect-python. |
| 4 | + |
| 5 | +1. Clone the repo, ensuring you have the latest main. |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +- If there are only bug fixes and no new features, run `uv run just bump patch`. |
| 10 | +- If there are features being released, run `uv run just bump minor`. |
| 11 | + |
| 12 | +Note the new version X.Y.Z in the updated files. |
| 13 | + |
| 14 | +3. Open a PR titled "Prepare for vX.Y.Z" ([Example PR #661](https://github.com/connectrpc/connect-go/pull/661)) and a description tagging all current maintainers. Once it's reviewed and CI passes, merge it. |
| 15 | + |
| 16 | + _Make sure no new commits are merged until the release is complete._ |
| 17 | + |
| 18 | +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. This will help auto-generated release notes match the final notes as closely as possible. |
| 19 | + |
| 20 | +5. Using the Github UI, create a new release. |
| 21 | + |
| 22 | + - Under “Select tag”, type in “vX.Y.Z” to create a new tag for the release upon publish. |
| 23 | + - Target the main branch. |
| 24 | + - Title the Release “vX.Y.Z”. |
| 25 | + - Click “set as latest release”. |
| 26 | + - Set the last version as the “Previous tag”. |
| 27 | + - Click “Generate release notes” to autogenerate release notes. |
| 28 | + - Edit the release notes. A summary and other sub categories may be added if required but should, in most cases, be left as ### 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! |
| 29 | + |
| 30 | +6. Publish the release. |
| 31 | + |
| 32 | +[latest release]: https://github.com/connectrpc/connect-python/releases/latest |
0 commit comments