From b62c06876b19110cda4f94a3edadd289baba8596 Mon Sep 17 00:00:00 2001 From: Panu Lahtinen Date: Mon, 8 Apr 2019 12:57:57 +0300 Subject: [PATCH 1/4] Clarify release instructions --- RELEASING.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 72fd292b17..7b725b046a 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -3,23 +3,27 @@ 1. checkout master 2. pull from repo 3. run the unittests -4. run `loghub` and update the `CHANGELOG.md` file: +4. run `loghub`. Replace and with proper + values. To get the previous version run `git --tag` and select the most + recent with highest version number. ``` -loghub pytroll/satpy -u -st v0.8.0 -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes" +loghub pytroll/satpy -u -st v -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes" ``` -Don't forget to commit! +This command will create a CHANGELOG.temp file which need to be added +to the top of the CHANGLOG.md file. Remember to update also the +version number to the same given in step 5. Don't forget to commit +CHANGELOG.md! 5. Create a tag with the new version number, starting with a 'v', eg: ``` -git tag -a v0.22.45 -m "Version 0.22.45" +git tag -a v -m "Version " ``` See [semver.org](http://semver.org/) on how to write a version number. - 6. push changes to github `git push --follow-tags` 7. Verify travis tests passed and deployed sdist and wheel to PyPI From affc152f4c9e794c87367a06d507298d7c65de21 Mon Sep 17 00:00:00 2001 From: Panu Lahtinen Date: Mon, 8 Apr 2019 17:14:40 +0300 Subject: [PATCH 2/4] Fix git tag command --- RELEASING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index 7b725b046a..5cf43b43d4 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,7 +4,7 @@ 2. pull from repo 3. run the unittests 4. run `loghub`. Replace and with proper - values. To get the previous version run `git --tag` and select the most + values. To get the previous version run `git tag` and select the most recent with highest version number. ``` From 30eede0930e526de43c8467f15751e6e31f572fc Mon Sep 17 00:00:00 2001 From: Panu Lahtinen Date: Mon, 8 Apr 2019 17:56:40 +0300 Subject: [PATCH 3/4] Add a clarifying example --- RELEASING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/RELEASING.md b/RELEASING.md index 5cf43b43d4..057f186661 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -22,6 +22,13 @@ CHANGELOG.md! git tag -a v -m "Version " ``` +For example if the previous tag was `v0.9.0` and the new release is a +patch release, do: + +``` +git tag -a v0.9.1 -m "Version 0.9.1" +``` + See [semver.org](http://semver.org/) on how to write a version number. From af0a04c7df799586b8cd78b9ee2d9b16610d0bf7 Mon Sep 17 00:00:00 2001 From: Panu Lahtinen Date: Mon, 8 Apr 2019 17:58:43 +0300 Subject: [PATCH 4/4] Mention that the stdout print is the same as in CHANGELOG.temp --- RELEASING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 057f186661..8b70410716 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -12,8 +12,9 @@ loghub pytroll/satpy -u -st v -plg bug "Bugs ``` This command will create a CHANGELOG.temp file which need to be added -to the top of the CHANGLOG.md file. Remember to update also the -version number to the same given in step 5. Don't forget to commit +to the top of the CHANGLOG.md file. The same content is also printed +to terminal, so that can be copy-pasted, too. Remember to update also +the version number to the same given in step 5. Don't forget to commit CHANGELOG.md! 5. Create a tag with the new version number, starting with a 'v', eg: