Add releasing doc (#472)

This commit is contained in:
Dominic Hamon 2017-11-03 12:45:16 -07:00 committed by GitHub
parent 336bb8db98
commit 1e52560157
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

16
releasing.md Normal file
View file

@ -0,0 +1,16 @@
# How to release
* Make sure you're on master and synced to HEAD
* Ensure the project builds and tests run (sanity check only, obviously)
* `parallel -j0 exec ::: test/*_test` can help ensure everything at least
passes
* Prepare release notes
* `git log $(git describe --abbrev=0 --tags)..HEAD` gives you the list of
commits between the last annotated tag and HEAD
* Pick the most interesting.
* Create a release through github's interface
* Note this will create a lightweight tag.
* Update this to an annotated tag:
* `git pull --tags`
* `git tag -a -f <tag> <tag>`
* `git push --force origin`