From d5b13facecd6ed8ab52951fe718695f82a6838e3 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Mon, 23 Mar 2020 17:30:24 -0400 Subject: [PATCH 1/4] tweaks to how_to_release --- HOW_TO_RELEASE.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md index 4ef7342a5ed..2b4fb52e7f6 100644 --- a/HOW_TO_RELEASE.md +++ b/HOW_TO_RELEASE.md @@ -23,7 +23,7 @@ Time required: about an hour. 4. Check that the ReadTheDocs build is passing. 5. On the master branch, commit the release in git: ``` - git commit -a -m 'Release v0.X.Y' + git commit -am 'Release v0.X.Y' ``` 6. Tag the release: ``` @@ -60,10 +60,35 @@ Time required: about an hour. It's OK to force push to 'stable' if necessary. (We also update the stable branch with `git cherrypick` for documentation only fixes that apply the current released version.) -12. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst. +12. Add a section for the next release (v.X.Y+1) to doc/whats-new.rst: + ``` + .. _whats-new.0.X.Y+1: + + v0.X.Y+1 (unreleased) + --------------------- + + Breaking changes + ~~~~~~~~~~~~~~~~ + + + New Features + ~~~~~~~~~~~~ + + + Bug fixes + ~~~~~~~~~ + + + Documentation + ~~~~~~~~~~~~~ + + + Internal Changes + ~~~~~~~~~~~~~~~~ + ``` 13. Commit your changes and push to master again: ``` - git commit -a -m 'New whatsnew section' + git commit -am 'New whatsnew section' git push upstream master ``` You're done pushing to master! From 6979a978f220090de7b597b1c580cb515508484e Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Mon, 23 Mar 2020 18:45:45 -0400 Subject: [PATCH 2/4] previous release --- HOW_TO_RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md index 2b4fb52e7f6..a994e310851 100644 --- a/HOW_TO_RELEASE.md +++ b/HOW_TO_RELEASE.md @@ -113,7 +113,7 @@ Time required: about an hour. ``` git log "$(git tag --sort="v:refname" | sed -n 'x;$p').." --format="%aN" | sort -u ``` - or by replacing `v0.X.Y` with the _previous_ release in: + or by substituting the _previous_ release in: ``` git log v0.X.Y.. --format="%aN" | sort -u ``` From ac5ab43e5b144adbf38f0a74781e662fa06a35ab Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Mon, 23 Mar 2020 19:05:02 -0400 Subject: [PATCH 3/4] copy paste list of names looks terrible --- HOW_TO_RELEASE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md index a994e310851..1ba0a1af722 100644 --- a/HOW_TO_RELEASE.md +++ b/HOW_TO_RELEASE.md @@ -115,8 +115,10 @@ Time required: about an hour. ``` or by substituting the _previous_ release in: ``` - git log v0.X.Y.. --format="%aN" | sort -u + git log v0.X.Y-1.. --format="%aN" | sort -u ``` + NB: copying this output into a Google Groups form can cause + [issues](https://groups.google.com/forum/#!topic/xarray/hK158wAviPs) with line breaks, so take care Note on version numbering: From a09dcca3ed50b7f7a40b9be4ebb73a83489f7826 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Mon, 23 Mar 2020 19:12:15 -0400 Subject: [PATCH 4/4] should not show --- HOW_TO_RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md index 1ba0a1af722..3fdd1d7236d 100644 --- a/HOW_TO_RELEASE.md +++ b/HOW_TO_RELEASE.md @@ -123,7 +123,7 @@ Time required: about an hour. Note on version numbering: We follow a rough approximation of semantic version. Only major releases (0.X.0) -show include breaking changes. Minor releases (0.X.Y) are for bug fixes and +should include breaking changes. Minor releases (0.X.Y) are for bug fixes and backwards compatible new features, but if a sufficient number of new features have arrived we will issue a major release even if there are no compatibility breaks.