Skip to content
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.

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

Add docs re stable branch #4444

Merged
merged 3 commits into from
Sep 22, 2020
Merged
Changes from 1 commit
Commits
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
12 changes: 9 additions & 3 deletions HOW_TO_RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@ upstream https://github.com/pydata/xarray (push)

1. Ensure your master branch is synced to upstream:
```sh
git switch master
git pull upstream master
```
2. Confirm there are no commits on stable that are not yet merged
([ref](https://github.com/pydata/xarray/issues/2821)):
```sh
git merge upstream stable
```
2. Add a list of contributors with:
```sh
git log "$(git tag --sort="v:refname" | sed -n 'x;$p').." --format=%aN | sort -u | perl -pe 's/\n/$1, /'
Expand Down Expand Up @@ -81,12 +87,12 @@ upstream https://github.com/pydata/xarray (push)
```
15. Update the stable branch (used by ReadTheDocs) and switch back to master:
```sh
git checkout stable
git switch stable
git rebase master
git push --force upstream stable
git checkout master
git switch master
```
It's OK to force push to 'stable' if necessary. (We also update the stable
It's OK to force push to `stable` if necessary. (We also update the stable
branch with `git cherry-pick` for documentation only fixes that apply the
current released version.)
16. Add a section for the next release {0.X.Y+1} to doc/whats-new.rst:
Expand Down