Triggering Tests

Tests can be triggered in two ways: manually from the Heal dashboard, or automatically from your CI pipeline using the Heal GitHub Action.

Manual triggers

To run a test suite manually:

1. Open your project in the Heal dashboard and go to the Tests tab.
2. Select the suite you want to run.
3. Click Run now.

The run will appear in the Results tab as soon as it starts.

GitHub Action

The heal-dev/heal-trigger GitHub Action lets you trigger a Heal test run as part of any workflow — for example, after a deployment to staging.

Setup

1. Add your Heal API key as a secret in your GitHub repository (e.g. HEAL_API_KEY). See Secrets for how to create an API key.
2. Add the action to your workflow:

- name: Run Heal tests
  uses: heal-dev/heal-trigger@v1
  with:
    api-key: ${{ secrets.HEAL_API_KEY }}

Waiting for results

By default the action triggers the run and exits immediately. To block the workflow until the run completes and fail the job if any tests fail, set wait to true:

- name: Run Heal tests
  uses: heal-dev/heal-trigger@v1
  with:
    api-key: ${{ secrets.HEAL_API_KEY }}
    wait: true

See the action repository for the full list of inputs and outputs.