Run workflows on CRACI runners

CRACI runners are GitHub Actions-compatible: an existing workflow runs on CRACI by changing the job’s runs-on to craci. This guide covers how you can set up your workflow YAML. To get started, you need to already have a CRACI account connected to your GitHub organization or repositories.

jobs:
  build:
    runs-on: craci
    steps:
      - uses: cracicorp/setup@v1
        with:
          size: "4"
          image: "default"
      - uses: actions/checkout@v4
      - run: make build

Set runs-on: craci to send a job to a CRACI runner. The craci label is what GitHub uses to queue the job for CRACI. This is the minimum setup. Add the setup step to choose the runner size or image.

See Runner images for the available image names.

Malformed resource inputs such as a non-numeric size use the default resource value. An unknown image name is rejected instead of running with a different image.