Skip to content

Commit 1797a4f

Browse files
author
Stu Hood
authored
Clarify release docs for stable branches. (#6427)
### Problem The release docs currently indicate that you need to be on the master branch in order to execute a release, which is not the case for stable releases. ### Solution Clarify that you should be on the relevant release branch when releasing.
1 parent 432f030 commit 1797a4f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/docs/release.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,9 @@ whether a release is needed from a stable branch.
140140
---------------------
141141

142142
A dry run is not strictly required since CI includes one, but you might
143-
like to try one anyway; if so, releases should only be published from
144-
master, so get on master and ensure your version number commit is present.
145-
After confirming this, run.
143+
like to try one anyway. To do so, switch to your release branch (which will either be `master` for
144+
an unstable weekly release, or a release branch like `1.9.x` for a stable release), and ensure that
145+
your version number commit is present. After confirming this, run:
146146

147147
:::bash
148148
$ ./build-support/bin/release.sh -n
@@ -159,16 +159,18 @@ is not required.
159159
------------------
160160

161161
Once the first two travis shards (the "binary builder" shards) have completed for your release
162-
commit, you can publish to PyPi. First, ensure you are on the master branch at the release commit.
163-
If new commits have landed after your release commit, you can reset to your commit
164-
(`git reset --hard <sha>`). Then, publish the release:
162+
commit, you can publish to PyPi. First, ensure that you are on your release branch at your version
163+
bump commit. Then, publish the release:
165164

166165
:::bash
167166
$ ./build-support/bin/release.sh
168167

169168
This also performs a dry run and then proceeds to upload the smoke
170169
tested wheels to PyPi. It may take a few minutes for the packages to be downloadable.
171170

171+
Note: If you are releasing from `master` and new commits have landed after your release commit, you
172+
can reset to your commit (`git reset --hard <sha>`) before publishing.
173+
172174
4. Announce
173175
-----------
174176

0 commit comments

Comments
 (0)