Skip to content

Commit c707b33

Browse files
authored
Tweaks to "how_to_release" (#3882)
* tweaks to how_to_release * previous release * copy paste list of names looks terrible * should not show
1 parent a2cccd6 commit c707b33

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

HOW_TO_RELEASE.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Time required: about an hour.
2323
4. Check that the ReadTheDocs build is passing.
2424
5. On the master branch, commit the release in git:
2525
```
26-
git commit -a -m 'Release v0.X.Y'
26+
git commit -am 'Release v0.X.Y'
2727
```
2828
6. Tag the release:
2929
```
@@ -60,10 +60,35 @@ Time required: about an hour.
6060
It's OK to force push to 'stable' if necessary. (We also update the stable
6161
branch with `git cherrypick` for documentation only fixes that apply the
6262
current released version.)
63-
12. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst.
63+
12. Add a section for the next release (v.X.Y+1) to doc/whats-new.rst:
64+
```
65+
.. _whats-new.0.X.Y+1:
66+
67+
v0.X.Y+1 (unreleased)
68+
---------------------
69+
70+
Breaking changes
71+
~~~~~~~~~~~~~~~~
72+
73+
74+
New Features
75+
~~~~~~~~~~~~
76+
77+
78+
Bug fixes
79+
~~~~~~~~~
80+
81+
82+
Documentation
83+
~~~~~~~~~~~~~
84+
85+
86+
Internal Changes
87+
~~~~~~~~~~~~~~~~
88+
```
6489
13. Commit your changes and push to master again:
6590
```
66-
git commit -a -m 'New whatsnew section'
91+
git commit -am 'New whatsnew section'
6792
git push upstream master
6893
```
6994
You're done pushing to master!
@@ -88,15 +113,17 @@ Time required: about an hour.
88113
```
89114
git log "$(git tag --sort="v:refname" | sed -n 'x;$p').." --format="%aN" | sort -u
90115
```
91-
or by replacing `v0.X.Y` with the _previous_ release in:
116+
or by substituting the _previous_ release in:
92117
```
93-
git log v0.X.Y.. --format="%aN" | sort -u
118+
git log v0.X.Y-1.. --format="%aN" | sort -u
94119
```
120+
NB: copying this output into a Google Groups form can cause
121+
[issues](https://groups.google.com/forum/#!topic/xarray/hK158wAviPs) with line breaks, so take care
95122
96123
Note on version numbering:
97124
98125
We follow a rough approximation of semantic version. Only major releases (0.X.0)
99-
show include breaking changes. Minor releases (0.X.Y) are for bug fixes and
126+
should include breaking changes. Minor releases (0.X.Y) are for bug fixes and
100127
backwards compatible new features, but if a sufficient number of new features
101128
have arrived we will issue a major release even if there are no compatibility
102129
breaks.

0 commit comments

Comments
 (0)