aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Haines <mjark@negativecurvature.net>2016-09-14 11:48:15 +0100
committerMark Haines <mjark@negativecurvature.net>2016-09-14 11:48:15 +0100
commit7647555fc719a4dac81391e596ad5858ad7c0e1d (patch)
tree52842d493673da6685af51771d9dc62290b43952
parent6dfa64342ac01b66f1e84bf4ffafd0a12d3c1b6d (diff)
Make release instructions more C+Pable
-rw-r--r--README.rst22
1 files changed, 13 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index 1a3663a..3d4db70 100644
--- a/README.rst
+++ b/README.rst
@@ -32,15 +32,19 @@ To build the javascript bindings, install emscripten from http://kripken.github.
Release process
---------------
-# Bump version numbers in ``Makefile`` and ``javascript/package.json``
-# Prepare changelog
-# ``git commit``
-# ``make test``
-# ``make js``
-# ``npm pack javascript``
-# ``scp olm-x.y.z.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/``
-# ``git tag x.y.z``
-# ``git push --tags``
+.. code:: bash
+
+ # Bump version numbers in ``Makefile`` and ``javascript/package.json``
+ # Prepare changelog
+ git commit
+ make clean
+ make test
+ make js
+ npm pack javascript
+ VERSION=x.y.z
+ scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/``
+ git tag $VERSION
+ git push --tags
It's probably sensible to do the above on a release branch (``release-vx.y.z``
by convention), and merge back to master once complete.