GitHub Actions
Maestro Cloud 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 Maestro Cloud GitHub Action.
This doesn’t cost anything up front and you’ll have $10 of free credit each month to play around with the platform. If you haven’t already, start by creating a Maestro Cloud account: Create a Maestro Cloud Account
The GitHub Action will need to authenticate with Maestro Cloud. So the first step is to expose your API key as a GitHub “Repository Secret”.
Grab your API key
- 1.Log in to Maestro Cloud Console, click on your username in bottom left corner and click on View API Key
- 2.Copy your API Key and save it somewhere. You will need it in next steps!
Add your API key as a “Repository Secret”
- 1.Navigate to your GitHub repo and click on Settings in top nav bar.
- 2.In repository settings page click on
Secrets -> Actions
. It will open Action Secrets page. - 3.On Action Secrets page, click on
New Repository Secret
button. UseMAESTRO_CLOUD_API_KEY
as the secret name and paste your API key from the previous step into the “Secret” value text box. Click “Add Secret” to add the secret.
Create a
.maestro/
directory at the root of your repository and commit your Flows there:<root>
├── .maestro/
│ ├── Login.yaml
│ ├── Add to Cart.yaml
│ └── Search.yaml
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.<root>