Skip to content

Commit 4f414f2

Browse files
max-sixtykeewis
andauthored
Add docs re stable branch (#4444)
* Add docs re stable branch * Update HOW_TO_RELEASE.md Co-authored-by: keewis <[email protected]> Co-authored-by: keewis <[email protected]>
1 parent 57ae5a4 commit 4f414f2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

HOW_TO_RELEASE.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,14 @@ upstream https://github.com/pydata/xarray (push)
1515

1616
1. Ensure your master branch is synced to upstream:
1717
```sh
18+
git switch master
1819
git pull upstream master
1920
```
21+
2. Confirm there are no commits on stable that are not yet merged
22+
([ref](https://github.com/pydata/xarray/pull/4440)):
23+
```sh
24+
git merge upstream stable
25+
```
2026
2. Add a list of contributors with:
2127
```sh
2228
git log "$(git tag --sort="v:refname" | sed -n 'x;$p').." --format=%aN | sort -u | perl -pe 's/\n/$1, /'
@@ -81,12 +87,12 @@ upstream https://github.com/pydata/xarray (push)
8187
```
8288
15. Update the stable branch (used by ReadTheDocs) and switch back to master:
8389
```sh
84-
git checkout stable
90+
git switch stable
8591
git rebase master
8692
git push --force upstream stable
87-
git checkout master
93+
git switch master
8894
```
89-
It's OK to force push to 'stable' if necessary. (We also update the stable
95+
It's OK to force push to `stable` if necessary. (We also update the stable
9096
branch with `git cherry-pick` for documentation only fixes that apply the
9197
current released version.)
9298
16. Add a section for the next release {0.X.Y+1} to doc/whats-new.rst:

0 commit comments

Comments
 (0)