GitHub Actions
Last updated
Was this helpful?
Last updated
Was this helpful?
Maestro cloud testing is compatible with all CI systems and provides native integrations with a number of common providers including GitHub Actions. You can start running your Flows in CI with just a few lines of configuration using the .
The GitHub Action will need to authenticate with your Maestro account. So the first step is to expose your API key as a GitHub “Repository Secret”.
Add your API key as a “Repository Secret”
Navigate to your GitHub repo and click on Settings in top nav bar.
In repository settings page click on Secrets -> Actions. It will open Action Secrets page.
On Action Secrets page, click on New Repository Secret button. Use MAESTRO_API_KEY as the secret name and paste your Maestro API key from the previous step into the “Secret” value text box. Click “Add Secret” to add the secret.
Add your Project ID
The project ID is not a secret, so you either specify it as project-id in your workflow file or you add it as an env variable.
Other setup
Please refer to the Action documentation to see all configuration options.
Create a .maestro/ directory at the root of your repository and commit your Flows there:
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.
Next, you’ll need to update your GitHub Actions workflow to add in the Maestro Cloud step. The workflows above execute generally the same steps for each platform:
For every push or pull_request to main branch trigger this job
Build the application
Upload the built application and Flow files to Maestro Cloud
Note the MAESTRO_API_KEY is the same secret you added to your Github repository earlier
Below you can find various examples for different platforms for how to structure your GitHub action to build and upload your app to Maestro Cloud:
Check out the Maestro Cloud Action for more information on how to configure the step.