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-testsworkflow on bothmainand a feature branch. When triggering a job, the branch determines which copy runs.
Required Fields
| Attribute | Type | Description |
|---|---|---|
| name | string | Unique name of the workflow. |
| description | string | Description of the workflow. |
| runs-on | string | Label that identifies the devices on which the workflow can be run. |
Optional Fields
| Attribute | Type | Description |
|---|---|---|
| disabled | boolean | Indicates whether the workflow is disabled. If set to true, no jobs can be executed using this workflow. |
| image | string or object | Container 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 -wor the action’sworkflowinput. - Triggers and notification rules that use the old name need the new name.