Document the release process

This commit is contained in:
Richard van der Hoff 2016-07-11 14:51:04 +01:00
parent d30db7b5c0
commit f03febb772

View file

@ -27,14 +27,23 @@ To build the javascript bindings, install emscripten from http://kripken.github.
.. code:: bash
make js
npm pack javascript # packages olm.js into olm-x.y.z.tgz
Remember to make a tag after releasing a tarball:
Release process
---------------
.. code:: bash
# 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``
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.
git tag x.y.z
git push --tags
Design
------