Shipfox
How-to GuidesAuthor Workflows

Choose Runners for Shipfox Workflow Jobs

Match job labels with Shipfox runners and change the runner for selected jobs.

Runner labels describe where a job can run. A runner must have every label the job needs.

Before you begin

You need a project that can sync workflows and access to the runner process or provisioner template whose labels should claim the job.

Match a workflow to a runner

Find the runner's labels

Check SHIPFOX_RUNNER_LABELS in the runner process. For a provisioner, check its matching template. The dashboard does not list online runner labels yet.

Set the workflow default

Add labels to the top-level runner field. Replace the example with labels from the runner. This is a complete workflow:

# yaml-language-server: $schema=https://www.shipfox.io/docs/workflow.schema.json
name: Verify on Linux
runner: [linux, x64] # Replace with labels from your runner.

triggers:
  manual:
    source: manual
    event: fire

jobs:
  verify:
    steps:
      - key: platform
        run: uname -a

Override one job when needed

A job-level runner value replaces the workflow default. For example, add runner: [linux, gpu] to a job that needs both labels. One runner must have the full set.

Run and verify the job

Commit and push the file to the project's default branch. Start it from the Workflows tab. The job leaves pending after a matching runner claims it.

If the job remains pending, use Resolve pending jobs. Runner registration and label configuration stay in the Runner reference.

Was this page helpful?
Edit this page on GitHub

On this page