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.

Note: Changing the name of the workflow will archive the existing workflow and create a new one. This action will also archive all previously associated jobs. Please exercise caution when renaming workflows. You may transfer jobs from an archived workflow to another one inside the webui.

Example

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