-
Notifications
You must be signed in to change notification settings - Fork 4
Configure bump-my-version #53
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.
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Releasing connect-python | ||
|
|
||
| This document outlines how to create a release of connect-python. | ||
|
|
||
| 1. Clone the repo, ensuring you have the latest main. | ||
|
|
||
| 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 just bump patch`. | ||
| - If there are features being released, run `uv run just bump minor`. | ||
|
|
||
| Note the new version X.Y.Z in the updated files. | ||
|
|
||
| 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. | ||
|
|
||
| _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. This will help auto-generated release notes match the final notes as closely as possible. | ||
|
|
||
| 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 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! | ||
|
|
||
| 6. Publish the release. | ||
|
|
||
| [latest release]: https://github.com/connectrpc/connect-python/releases/latest | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will update to a connect-python URL after the next release