diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 36 |
1 files changed, 30 insertions, 6 deletions
@@ -39,25 +39,49 @@ To build the android project for Android bindings, run: cd android ./gradlew clean assembleRelease +To build the Xcode workspace for Objective-C bindings, run: + +.. code:: bash + + cd xcode + pod install + open OLMKit.xcworkspace + 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 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. + # OLMKit CocoaPod release + # Make sure the version OLMKit.podspec is the same as the git tag + # (this must be checked before git tagging) + pod spec lint OLMKit.podspec --use-libraries --allow-warnings + pod trunk push OLMKit.podspec --use-libraries --allow-warnings + # Check the pod has been successully published with: + pod search OLMKit Design |