Skip to content

docs: tell how to create a release branch for patch releases #2329

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
merged 6 commits into from
Oct 27, 2024
Merged

docs: tell how to create a release branch for patch releases #2329

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4413d94
doc how to create release branch for patch release
rickeylev Oct 22, 2024
bddd317
Merge branch 'main' of https://github.com/bazelbuild/rules_python int…
rickeylev Oct 23, 2024
e9dca20
Update DEVELOPING.md
rickeylev Oct 23, 2024
d069601
Merge branch 'main' of https://github.com/bazelbuild/rules_python int…
rickeylev Oct 23, 2024
9974f4f
add -x to cherry pick
rickeylev Oct 23, 2024
c6401af
Merge branch 'main' of https://github.com/bazelbuild/rules_python int…
rickeylev Oct 26, 2024
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
26 changes: 25 additions & 1 deletion DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Start from a clean checkout at `main`.
Before running through the release it's good to run the build and the tests locally, and make sure CI is passing. You can
also test-drive the commit in an existing Bazel workspace to sanity check functionality.

### Releasing from HEAD

#### Steps
1. [Determine the next semantic version number](#determining-semantic-version)
1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
Expand All @@ -38,9 +40,31 @@ To find if there were any features added or incompatible changes made, review
the commit history. This can be done using github by going to the url:
`https://github.com/bazelbuild/rules_python/compare/<VERSION>...main`.

### Patch release with cherry picks

If a patch release from head would contain changes that aren't appropriate for
a patch release, then the patch release needs to be based on the original
release tag and the patch changes cherry-picked into it.

In this example, release `0.37.0` is being patched to create release `0.37.1`.
The fix being included is commit `deadbeef`.

1. `git checkout -b release/0.37 0.37.0`
1. `git push upstream release/0.37`
1. `git cherry-pick deadbeef`
1. Fix merge conflicts, if any. If `MODULE.bazel.lock` conflicts occur, then
run `tools/private/update_bzlmod_lockfiles.sh`
1. `git cherry-pick --continue` (if applicable)
1. `git push upstream`

If multiple commits need to be applied, repeat the `git cherry-pick` step for
each.

Once the release branch is in the desired state, use `git tag` to tag it, as
done with a release from head. Release automation will do the rest.

#### After release creation in Github

1. Ping @philwo to get the new release added to mirror.bazel.build. See [this comment on issue #400](https://github.com/bazelbuild/rules_python/issues/400#issuecomment-779159530) for more context.
1. Announce the release in the #python channel in the Bazel slack (bazelbuild.slack.com).

## Secrets
Expand Down