MaestroDeck Cloud Action

Run Maestro mobile tests on MaestroDeck Cloud from your CI, on iOS or Android, with a single step. The build fails if the tests fail.

- uses: BlueShork/maestro-action@v1
  with:
    api_key: ${{ secrets.MAESTRO_API_KEY }}
    platform: android
    app: build/app-release.apk
    flow: .maestro/

How it works

The action uploads your app and flows to MaestroDeck Cloud, runs them on a real simulator/emulator, waits for the result, and exits 0 (passed) or 1 (failed/error). Android jobs dispatch instantly; iOS jobs run on the macOS worker pool. You get the same pipeline as the web dashboard, triggered from CI.

Setup

1. Generate an API key: open your MaestroDeck dashboard profile page, section API keys, click Generate key. Copy it (it is shown only once).
2. Add it as a secret in your repo: Settings → Secrets and variables → Actions → New repository secret, name MAESTRO_API_KEY.
3. Add the step to a workflow (see examples below).

Inputs

Input	Required	Default	Description
api_key	yes		Your MaestroDeck API key (mk_live_...). Always pass it via a secret.
platform	yes		ios or android.
app	yes		Path to the .apk (Android) or .app.zip (iOS).
flow	yes		Path or glob to your Maestro .yaml flow files, or a directory of them.
email	no	account email	Send the report to a specific address instead of your account email.
timeout	no	1800	Max seconds to wait for the result before giving up. Does not change the run's own server-side timeout.

Outputs

Output	Description
job_id	The created job id.
status	Final status: passed, failed, or error.
report_url	Link to the full report in the dashboard.

Examples

Android

name: E2E
on: [push]
jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # ... build your APK into build/app-release.apk ...
      - uses: BlueShork/maestro-action@v1
        with:
          api_key: ${{ secrets.MAESTRO_API_KEY }}
          platform: android
          app: build/app-release.apk
          flow: .maestro/

iOS

- uses: BlueShork/maestro-action@v1
  with:
    api_key: ${{ secrets.MAESTRO_API_KEY }}
    platform: ios
    app: build/MyApp.app.zip
    flow: .maestro/login.yaml

Using the outputs

- uses: BlueShork/maestro-action@v1
  id: maestro
  with:
    api_key: ${{ secrets.MAESTRO_API_KEY }}
    platform: android
    app: build/app-release.apk
    flow: .maestro/
- if: always()
  run: echo "Report: ${{ steps.maestro.outputs.report_url }}"

Notes

• flow accepts a single file (.maestro/login.yaml), a glob (.maestro/*.yaml), or a directory (.maestro/, which picks up every .yaml/.yml inside).
• The step consumes one run from your MaestroDeck quota per invocation.
• Requires curl and jq, both preinstalled on GitHub-hosted runners.

License

MIT