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.

Sign up for GitHub

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

Jump to bottom

Clarify release instructions #701

Merged
merged 4 commits into from
Apr 9, 2019
Merged

Clarify release instructions #701

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b62c068
Clarify release instructions
pnuu Apr 8, 2019
affc152
Fix git tag command
pnuu Apr 8, 2019
30eede0
Add a clarifying example
pnuu Apr 8, 2019
af0a04c
Mention that the stdout print is the same as in CHANGELOG.temp
pnuu Apr 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 17 additions & 5 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <github username> and <previous version> with proper
values. To get the previous version run `git tag` and select the most
recent with highest version number.

```
loghub pytroll/satpy -u <username> -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 <github username> -st v<previous version> -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!
djhoese marked this conversation as resolved.
Show resolved Hide resolved

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<new version> -m "Version <new version>"
djhoese marked this conversation as resolved.
Show resolved Hide resolved
```

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`
Expand Down