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

Use the hosted runner reference for Shipfox Cloud. For a runner you manage, you also need access to its process or provisioner template.

Match a workflow to a runner

Find the runner's labels

Use shipfox for the default Shipfox-hosted runner. To choose a different size, compare the available runners.

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

Set the workflow default

Set the top-level runner field. This is a complete workflow using the default Shipfox-hosted runner:

# yaml-language-server: $schema=https://www.shipfox.io/docs/workflow.schema.json
name: Verify on Linux
runner: shipfox

triggers:
  manual:
    source: manual

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: shipfox-8cpu to a build job that needs more capacity.

For a runner you manage, the value can be a list such as [linux, gpu]. 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