diff --git a/RELEASING.md b/RELEASING.md index 72fd292b17..8b70410716 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -3,22 +3,34 @@ 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. 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: ``` -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. +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. 6. push changes to github `git push --follow-tags`