From 1e52560157d73d7e180e6e2c8d928be5a8e99795 Mon Sep 17 00:00:00 2001 From: Dominic Hamon Date: Fri, 3 Nov 2017 12:45:16 -0700 Subject: [PATCH] Add releasing doc (#472) --- releasing.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 releasing.md diff --git a/releasing.md b/releasing.md new file mode 100644 index 00000000..f0cd7010 --- /dev/null +++ b/releasing.md @@ -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 ` + * `git push --force origin`