Skip to content

Commit 03969c2

Browse files
authored
docs: tell how to push one tag; that rc start with n=0 (#3222)
If your local repo tags don't match the remote, then `git push --tags` will push _all_ tags. This confuses the release workflow and it doesn't trigger properly. It can also push junk tags and trigger an accidental release (hence how a 0.1 release showed up months ago; I accidentally pushed a junk tag). Along the way, mention that N=0 to start with for RCs
1 parent 1bf67e0 commit 03969c2

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

RELEASING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,19 @@ The next step is to create tags to trigger release workflow, **however**
2828
we start by using release candidate tags (`X.Y.Z-rcN`) before tagging the
2929
final release (`X.Y.Z`).
3030

31-
1. Create release candidate tag and push. Increment `N` for each rc.
31+
1. Create release candidate tag and push. The first RC uses `N=0`. Increment
32+
`N` for each RC.
3233
```
33-
git tag X.Y.0-rcN upstream/release/X.Y && git push upstream --tags
34+
git tag X.Y.0-rcN upstream/release/X.Y && git push upstream tag X.Y.0-rcN
3435
```
3536
2. Announce the RC release: see [Announcing Releases]
3637
3. Wait a week for feedback.
3738
* Follow [Patch release with cherry picks] to pull bug fixes into the
3839
release branch.
3940
* Repeat the RC tagging step, incrementing `N`.
4041
4. Finally, tag the final release tag:
41-
```
42-
git tag X.Y.0 upstream/release/X.Y && git push upstream --tags
42+
```shell
43+
git tag X.Y.0 upstream/release/X.Y && git push upstream tag X.Y.0
4344
```
4445

4546
Release automation will create a GitHub release and BCR pull request.

0 commit comments

Comments
 (0)