Skip to content

Commit

Permalink
Merge pull request #184 from obsidiansystems/release-instructions-men…
Browse files Browse the repository at this point in the history
…tion-change-log

Mention change log in release instructions
  • Loading branch information
Ericson2314 committed Sep 29, 2020
2 parents 8e0ac6a + 92fd8d1 commit fb438e6
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,20 @@ according to the directions in [README.md](README.md).

# Releasing #

To create a new release:
To create a new release candidate:

* Choose a commit you want to release.
* Ensure it is part of a branch `release/M.N`
* Ensure `ChangeLog.md` describe the release
* Make a new commit on top of it, incrementing the version numbers in the Makefile appropriately.
* Tag the release candidate `vM.N.P-rcX`, where M, N, P, and X stand for appropriate numbers, e.g.: v0.4.1-rc2
* Make the actual tarballs with `app.hex` files using the provided script:
``` sh
$ nix/release.sh
```

``` sh
$ nix/release.sh
```
* Once it has passed QA, tag `vM.N.P`, e.g. v0.4.1
Once it has passed QA:

* Tag `vM.N.P`, e.g. v0.4.1
* Ensure `ChangeLog.md` has the right date
* Use the md5sum/sha256 section of the output of `nix/release.sh` as part of the markdown release notes on GitHub, and post the resulting two tarballs along with the release.

0 comments on commit fb438e6

Please sign in to comment.