Integration with any CI platform
Last updated
Was this helpful?
Last updated
Was this helpful?
You can use the Maestro CLI to run your Flows in the cloud from any CI platform.
API Key
Reach out to your mobile.dev representative to obtain your Maestro API key
Project ID
The id of the project you want to upload your app and Flows to. You can retrieve this from the Maestro console.
iOS
Provide a path that points to an x86-compatible *.app simulator build directory, or a zipped file that contains the *.app build.
Android
You APK must be x86-compatible.
Add all of your Flows under a single directory in your repo. We recommend naming this directory .maestro/ as this is the naming convention our native integrations expect by default. (Note the "." at the beginning of .maestro/)
All of the flows directly under the .maestro/ directory will be executed as top-level flows.
It's common to have some Flow files that are only meant to be executed as part of another Flow via the runFlow command. These "subflows" can be nested under a subdirectory to prevent them from running as a top-level Flow.
In the example above, MySubflow.yaml will not be executed as a top-level Flow, but still can be referenced by other Flows using the runFlow command.
Add a step in your CI workflow that executes the maestro cloud command:
<apiKey>
Maestro API Key
<projectId>
Maestro Project ID
<appFile>
.maestro/
The directory that contains your Flows
To set a name for your upload, use the --name option:
The maestro cloud command and our native CI integrations will wait for your Flows to finish executing before returning.
If any Flow failures are detected, the exit code is set to 1. On success, the exit code will be set to 0. This allows you to leverage any existing test alerting you have in place.
A link to the current upload will be printed out to your logs. You can view any ongoing or past uploads in the Maestro console.
First, ensure that the on your CI machine:
The APK file or .app directory ()