timoreo/olm
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update release process instructions

Browse source
This commit is contained in:
Richard van der Hoff 2016-12-22 15:02:43 +00:00
parent e71dc46a1e
commit ac323b738d
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.rst
View file

@ -44,15 +44,26 @@ To build the Xcode workspace for Objective-C bindings, run:
Release process Release process
--------------- ---------------
.. code:: bash First: bump version numbers in ``Makefile``, ``javascript/package.json``, and
``OLMKit.podspec``.
# Bump version numbers in ``Makefile`` and ``javascript/package.json`` Also, ensure the changelog is up to date, and that everyting is committed to
# Prepare changelog git.
git commit
It's probably sensible to do the above on a release branch (``release-vx.y.z``
by convention), and merge back to master once the release is complete.
.. code:: bash
make clean make clean
# build and test C library
make test make test
# build and test JS wrapper
make js make js
(cd javascript && npm run test)
npm pack javascript npm pack javascript
VERSION=x.y.z VERSION=x.y.z
scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/ scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/
git tag $VERSION -s git tag $VERSION -s
@ -66,9 +77,6 @@ Release process
# Check the pod has been successully published with: # Check the pod has been successully published with:
pod search OLMKit pod search OLMKit
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.
Design Design
------ ------