From ac323b738d30686122b4840455fc92800820f658 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Thu, 22 Dec 2016 15:02:43 +0000
Subject: [PATCH] Update release process instructions
---
README.rst | 22 +++++++++++++++-------
1 file changed, 15 insertions(+), 7 deletions(-)
diff --git a/README.rst b/README.rst
index 0b2d915..4858277 100644
--- a/README.rst
+++ b/README.rst
@@ -44,15 +44,26 @@ To build the Xcode workspace for Objective-C bindings, run:
Release process
---------------
-.. code:: bash
+First: bump version numbers in ``Makefile``, ``javascript/package.json``, and
+``OLMKit.podspec``.
+
+Also, ensure the changelog is up to date, and that everyting is committed to
+git.
- # Bump version numbers in ``Makefile`` and ``javascript/package.json``
- # Prepare changelog
- 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
+
+ # build and test C library
make test
+
+ # build and test JS wrapper
make js
+ (cd javascript && npm run test)
npm pack javascript
+
VERSION=x.y.z
scp olm-$VERSION.tgz packages@ldc-prd-matrix-001:/sites/matrix/packages/npm/olm/
git tag $VERSION -s
@@ -66,9 +77,6 @@ Release process
# Check the pod has been successully published with:
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
------
--
GitLab