Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Run your Flows on [Maestro Cloud](https://app.maestro.dev).
Add the following to your workflow. Note that you can use the `v3` tag if you want to keep using the latest version of the action, which will automatically resolve to all `v3.minor.patch` versions as they get published.

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2' # replace this with your actual project id
Expand Down Expand Up @@ -93,7 +93,7 @@ For more information on triggering workflows, check out [GitHub's documentation]
## Android

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -107,7 +107,7 @@ For more information on triggering workflows, check out [GitHub's documentation]
Include the ProGuard mapping file to deobfuscate Android performance traces:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -118,7 +118,7 @@ Include the ProGuard mapping file to deobfuscate Android performance traces:
## iOS

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -131,7 +131,7 @@ Include the ProGuard mapping file to deobfuscate Android performance traces:
### .dSYM file

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -146,7 +146,7 @@ Include the ProGuard mapping file to deobfuscate Android performance traces:
By default, the action is looking for a `.maestro` folder with Maestro flows in the root directory of the project. If you would like to customize this behaviour, you can override it with a `workspace` argument:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -165,7 +165,7 @@ A name will automatically be provided according to the following order:
If you want to override this behaviour and specify your own name, you can do so by setting the `name` argument:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand Down Expand Up @@ -206,7 +206,7 @@ jobs:
HEAD_REF=$(gh pr view "$PR_NUMBER" --json headRefName --jq '.headRefName')
echo "branch=$HEAD_REF" >> $GITHUB_OUTPUT

- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -219,7 +219,7 @@ jobs:
If you don't want the action to wait until the Upload has been completed as is the default behaviour, set the `async` argument to `true`:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -230,7 +230,7 @@ If you don't want the action to wait until the Upload has been completed as is t
Alternatively, you might want to still wait for the action but would like to configure the timeout period, set `timeout` argument to a number of minutes:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -243,7 +243,7 @@ Alternatively, you might want to still wait for the action but would like to con
If you want to pass environment variables along with your upload, add a multiline `env` argument:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -260,7 +260,7 @@ You can use Maestro [Tags](https://maestro.mobile.dev/cli/tags) to filter which
You can either pass a single value, or comma-separated (`,`) values.

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -281,7 +281,7 @@ Supported values:
iOS example:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -293,7 +293,7 @@ iOS example:
Android example:

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -310,7 +310,7 @@ If your workspace contains Web tests that are supposed to run on a real browser,
You don't have to specify `app-file`.

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -323,13 +323,13 @@ You can use an already uploaded binary in Maestro Cloud using the `app-binary-id

```yaml
- id: upload
uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
app-file: app.zip

- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -341,7 +341,7 @@ You can use an already uploaded binary in Maestro Cloud using the `app-binary-id
To switch the device locale on a remote device from a default one (en_US) `device-locale` parameter should be used. The value is a combination of lowercase ISO-639-1 code and uppercase ISO-3166-1 code, i.e. "de_DE" for Germany.

```yaml
- uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
- uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand All @@ -362,7 +362,7 @@ In order to access these variables you can use the following approach:

```yaml
- id: upload
uses: mobile-dev-inc/action-maestro-cloud@v3.0.1
uses: mobile-dev-inc/action-maestro-cloud@v3.1.0
with:
api-key: ${{ secrets.MAESTRO_CLOUD_API_KEY }}
project-id: 'proj_01example0example1example2'
Expand Down
Loading