GitHub Actions

Use the MobileBoost GitHub Actions to upload a build and run your mobile tests from your CI pipeline:

upload-build uploads your iOS or Android build (.zip or .apk).
run-tests runs your tests against that build and reports pass or fail.

You do not need to install anything or use GitHub Marketplace. Reference the actions directly from MobileBoostHQ/actions.

Add your credentials

In your repository, go to Settings > Secrets and variables > Actions. In the Secrets tab, create a repository secret:

MOBILEBOOST_API_KEY: Your MobileBoost API key, such as mb_live_....

In the Variables tab, create a repository variable:

MOBILEBOOST_ORG_ID: Your MobileBoost organization ID.

You can find your API key and organization ID in the MobileBoost dashboard. You can also ask your MobileBoost contact for them.

Add a workflow

Create .github/workflows/mobileboost.yml in your repository:

name: Mobile tests
on:
  pull_request:
    branches: [main]

jobs:
  mobile-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Add your existing build steps that produce a .apk or .zip.

      - uses: MobileBoostHQ/actions/upload-build@v1
        id: upload
        with:
          api-key: ${{ secrets.MOBILEBOOST_API_KEY }}
          organisation-id: ${{ vars.MOBILEBOOST_ORG_ID }}
          build-path: app/build/outputs/apk/release/*.apk

      - uses: MobileBoostHQ/actions/run-tests@v1
        with:
          api-key: ${{ secrets.MOBILEBOOST_API_KEY }}
          organisation-id: ${{ vars.MOBILEBOOST_ORG_ID }}
          build-id: ${{ steps.upload.outputs.build-id }}
          tags: smoke

This runs on every pull request targeting main - when the PR is opened and on each new commit (synchronize), before the code is merged. Each run uploads the build, runs the tests tagged smoke, waits for them to finish, and fails the job if any test fails. The run summary includes a result table and recording links.

To block merges on failing tests, add this job as a required status check under Settings > Branches > Branch protection rules for main. A failing run then prevents the pull request from being merged - catching issues before they reach main rather than after.

On the pull_request trigger, builds from forked repositories run without access to your repository secrets, so MOBILEBOOST_API_KEY would be missing. This does not affect private repositories or pull requests opened from branches in the same repository (the usual case). Only if you accept pull requests from external forks on a public repository do you need the pull_request_target trigger instead, checking out the pull request head explicitly.

Key inputs

`upload-build`

Input	Required	Description
`api-key`	Yes	Your API key. Use the repository secret.
`organisation-id`	Yes	Your organization ID.
`build-path`	Yes	Path to a `.zip` or `.apk`, a directory that is zipped automatically, or a glob where the first match is used.

Outputs:

build-id: Pass this to run-tests.
app-link: Dashboard URL.

`run-tests`

Input	Required	Description
`api-key`	Yes	Your API key. Use the repository secret.
`organisation-id`	Yes	Your organization ID.
`build-id`	Yes	The `build-id` from the `upload-build` step output.
`tags`	One of `tags` or `test-ids`	Comma-separated tags. Runs tests matching any tag.
`test-ids`	One of `tags` or `test-ids`	Comma-separated test IDs. Takes precedence over `tags`.
`async`	No	Set to `true` to trigger the run without waiting. Defaults to `false`.
`timeout-minutes`	No	Maximum wait time in sync mode. Defaults to `60`.
`fail-on-test-failure`	No	Set to `false` to report results without failing the job. Defaults to `true`.

Provide at least one of tags or test-ids. If both are provided, test-ids takes precedence.

Common variations

Run specific tests with a shorter wait

- uses: MobileBoostHQ/actions/run-tests@v1
  with:
    api-key: ${{ secrets.MOBILEBOOST_API_KEY }}
    organisation-id: ${{ vars.MOBILEBOOST_ORG_ID }}
    build-id: ${{ steps.upload.outputs.build-id }}
    test-ids: t_abc123,t_def456
    timeout-minutes: 30

Trigger and inspect later

Set async to true to trigger the run without waiting for it to finish.

async: true

Report results without failing the job

Set fail-on-test-failure to false.

fail-on-test-failure: false

Also run after merging to `main`

To keep a post-merge baseline on main alongside the pre-merge pull request runs, trigger on both events:

on:
  pull_request:
    branches: [main]
  push:
    branches: [main]

Run only on a merged pull request

Change the workflow trigger:

on:
  pull_request:
    types: [closed]
jobs:
  mobile-tests:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    # Use the same steps as above.

Pin the version

@v1: Recommended. Automatically gets the latest v1.x.x release with bug fixes and no breaking changes.
@v1.2.3: Pins to an exact version for full reproducibility.
@main: Tracks the latest commit. This may include breaking changes, so it is not recommended for production.

Troubleshooting

Symptom	Fix
`Invalid API key (401)`	Check that `MOBILEBOOST_API_KEY` is set and uses your `mb_live_...` key.
`No file or directory matched build-path`	Make sure your build step ran and the path or glob is correct.
`Unsupported build file`	Only `.zip` and `.apk` files are supported.
Run `did not finish within the timeout`	Increase `timeout-minutes`, or use `async: true`. The run continues in MobileBoost.
Job fails with `N failed, M blocked`	Tests failed. Open the dashboard link in the run summary to view recordings.

Behind a corporate proxy, the actions honor HTTPS_PROXY, HTTP_PROXY, and NO_PROXY. They also support custom CA bundles via NODE_EXTRA_CA_CERTS. Questions or issues? Contact your MobileBoost representative.

Builds

Test cases

No-code test editor

Test results

Add your credentials

Add a workflow

Key inputs

`upload-build`

`run-tests`

Common variations

Run specific tests with a shorter wait

Trigger and inspect later

Report results without failing the job

Also run after merging to `main`

Run only on a merged pull request

Pin the version

Troubleshooting

​Add your credentials

​Add a workflow

​Key inputs

​upload-build

​run-tests

​Common variations

​Run specific tests with a shorter wait

​Trigger and inspect later

​Report results without failing the job

​Also run after merging to main

​Run only on a merged pull request

​Pin the version

​Troubleshooting

Add your credentials

Add a workflow

Key inputs

`upload-build`

`run-tests`

Common variations

Run specific tests with a shorter wait

Trigger and inspect later

Report results without failing the job

Also run after merging to `main`

Run only on a merged pull request

Pin the version

Troubleshooting