Workflow Configuration

Workflow

This configuration workflow.yaml describes a workflow. Below are the key components:

Branch scope: Every workflow belongs to a single branch of the project (see the Branches reference). A workflow name must be unique within its branch, but the same name can exist on multiple branches — for example a coreboot-tests workflow on both main and a feature branch. When triggering a job, the branch determines which copy runs.

Required Fields

AttributeTypeDescription
namestringUnique name of the workflow.
descriptionstringDescription of the workflow.
runs-onstringLabel that identifies the devices on which the workflow can be run.

Optional Fields

AttributeTypeDescription
disabledbooleanIndicates whether the workflow is disabled. If set to true, no jobs can be executed using this workflow.
imagestring or objectContainer image the workflow’s jobs run in. See Job Images.

Changing, Renaming and Deleting a Workflow

The sync identifies a workflow on its branch by its name. A push that changes nothing in workflow.yaml leaves the workflow as it is, also when its directory moved or a test changed. A changed description, runs-on, image or disabled gives the workflow a new version with a new ID; the job requests that ran with the old version keep it. A new name is a new workflow: the sync deletes the old workflow and adds the new one.

When a workflow gets a new version, is renamed or is deleted:

  • Its job requests stay on the branch, with the name and the configuration they ran with. A new version keeps the name, so its old runs stay listed with it. For a renamed or deleted workflow, turn on Show archived in the Workflow filter on the Job Requests page to select the old name.
  • Its queued and running jobs finish with the configuration they were queued with. The sync report says how many jobs still run.
  • A job request that names the old workflow by its ID is refused. Trigger workflows by name, for example with fwci run -w or the action’s workflow input.
  • Triggers and notification rules that use the old name need the new name.

Example

name: Prodrive-Hermes
description: Run tests on the Prodrive Hermes board.
runs-on: prodrivehermes