Skip to content

Commit fee6994

Browse files
committed
docs: tell how to create branches for releases
1 parent 9b5f5dd commit fee6994

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

DEVELOPING.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,20 @@ also test-drive the commit in an existing Bazel workspace to sanity check functi
2727
### Releasing from HEAD
2828

2929
#### Steps
30-
1. [Determine the next semantic version number](#determining-semantic-version)
31-
1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
32-
NOTE: Pushing the tag will trigger release automation.
33-
1. Watch the release automation run on https://github.com/bazelbuild/rules_python/actions
34-
1. Add missing information to the release notes. The automatic release note
35-
generation only includes commits associated with issues.
30+
1. [Determine the next semantic version number](#determining-semantic-version).
31+
1. Update CHANGELOG.md: replace the `v0-0-0` and `0.0.0` with `X.Y.0`.
32+
1. Replace `VERSION_NEXT_*` strings with `X.Y.0`.
33+
1. Send these changes for review and get them merged.
34+
1. Create a branch for the new release, named `release/X.Y`
35+
```
36+
git branch --no-track release/X.Y upstream/main && git push upstream release/X.Y
37+
```
38+
1. Create a tag and push:
39+
```
40+
git tag X.Y.0 upstream/release/X.Y && git push upstream --tags
41+
```
42+
**NOTE:** Pushing the tag will trigger release automation.
43+
1. Release automation will create a GitHub release and BCR pull request.
3644

3745
#### Determining Semantic Version
3846

@@ -54,8 +62,7 @@ release tag and the patch changes cherry-picked into it.
5462
In this example, release `0.37.0` is being patched to create release `0.37.1`.
5563
The fix being included is commit `deadbeef`.
5664

57-
1. `git checkout -b release/0.37 0.37.0`
58-
1. `git push upstream release/0.37`
65+
1. `git checkout release/0.37`
5966
1. `git cherry-pick -x deadbeef`
6067
1. Fix merge conflicts, if any.
6168
1. `git cherry-pick --continue` (if applicable)

0 commit comments

Comments
 (0)