Skip to main content

Start Heal on schedule

You can use the Heal API to run heal on schedule.

GitHub Actions​

You can use a GitHub action to run heal on schedyke, calling the Heal GitHub action.

  1. Create a heal API token, and set it as an actions secret (for example as HEAL_API_TOKEN).
  2. Create a GitHub action to run Heal on schedule, for example, here's an action to run everyday at UTC:
name: Daily run
on:
  schedule:
    - cron: '30 7 * * *' # Runs at 7:30 UTC everyday

jobs:
  heal-dev:
    name: Heal.dev
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Heal Suite Execution
        uses: heal-dev/trigger@v1
        with:
          api-token: ${{ secrets.HEAL_API_TOKEN }} # Required: Your Heal API token.
          suite: "project-test/suite-test" # Required: The slug of the project and suite `project-slug-name/suite-slug-name`.
          wait-for-results: "yes" # Optional: Wait for results (default: 'yes').
          comment-on-pr: "yes" # Optional: Whether to comment test results on PRs (default: 'no').

You can provide a payload to pick stories to run, override the entrypoint, or pass variables.