RELEASING.md

Production Releases

Prepare

1. Define the next semantic version

   Semantic versioning: a.b.c

   • a: major breaking changes
   • b: new functionality, new features
   • c: any other small changes

2. Checkout the main branch and make sure it is up-to-date: git checkout main && git pull

3. Create a new branch

4. Update the CHANGELOG.md file with changes of this release

5. Change the version in gradle.properties

6. Change the version in maestro-cli/gradle.properties

7. git commit -am "Prepare for release X.Y.Z." (where X.Y.Z is the new version)

8. Submit a PR with the changes against the main branch

9. Merge the PR

Tag

1. git tag -a vX.Y.Z -m "Version X.Y.Z" (where X.Y.Z is the new version)
2. git push --tags
3. Wait until all Publish actions have completed https://github.com/mobile-dev-inc/maestro/actions

Publish Maven and Android SDK

This step also published Maestro Android SDK.

1. Log in to Sonatype
2. Close the uploaded staging repository
3. Release the closed staging repository

Publish CLI

1. Trigger the Publish CLI Github action
2. Test installing the cli by running curl -Ls "https://get.maestro.mobile.dev" | bash
3. Check the version number maestro --version

Publish iOS SDK

This step is optional and only required if there are changes to the iOS SDK. Important note if your changes include new APIs or breaking changes - make sure to reflect that in React Native SDK as well.

Run this after a tag is pushed to remote.

./scripts/publish-ios-sdk.sh

Publish React Native SDK

This step is optional and only required if there are changes to the React Native SDK.

Before you start, make sure to sign in into npm package manager (credentials are in the shared password manager).

Then

./maestro-sdk/rn/scripts/publish.sh

Note that version name is imported automatically from gradle.properties and is set to match Maestro version.