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.

Minimal workflow

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

Note

cracicorp/setup@v1 is a pseudo-action: CRACI reads its with: inputs when scheduling the job and does not pull or execute it as a normal action. Omit the step entirely to run with default resources.

runs-on

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.

cracicorp/setup@v1 inputs

Input	Default	Description
size	"2"	Compute units, integer 1..32; each unit is 1 vCPU and 3 GB RAM
image	default	Runtime image name
disks	none	(planned) YAML list of persistent disk requests

Note

Only the default image is currently available. It tracks the ubuntu-slim image used by GitHub Actions runners.

Disk requests (planned)

Not yet available

Persistent disks are not provisioned yet. The schema below describes the planned disks input; supplying it today has no effect.

Each entry in disks describes one persistent disk:

- name: sstate
  mount: /work/sstate
  size: 100Gi
  mode: rw

• mount must be an absolute path.
• Disk names must be unique within the job.
• mode is rw or ro; omitting it defaults to rw.

Malformed inputs

Malformed cracicorp/setup inputs do not fail the job. If an input is invalid (for example a non-numeric size), CRACI schedules the job with default resources and runs it anyway. If a run does not get the size or image you expected, check the setup inputs for a typo.