Pipeline file reference

This reference is generated from the JSON Schema published at https://slipway.systems/schema/pipeline-v1.json. It is always in step with slipway validate. For a guided tour see Pipelines.

Editor support

Add the schema to your editor for completion and inline errors. For the YAML language server, put this on the first line of a pipeline file:

# yaml-language-server: $schema=https://slipway.systems/schema/pipeline-v1.json
version: 1
name: web

Pipelines live at .slipway/*.yaml (one pipeline per file) or slipway.yaml at the repository root.

A pipeline defines exactly one of stages, jobs (a single implicit stage) or extends (inherit from an org template and override by name).
name is required unless extends is used.
Unknown keys are rejected.

Key	Type	Required	Description
`version`	`1`	required	Pipeline format version. Always 1.
`name`	string		Display name, unique per project. Min length: 1.
`description`	string
`extends`	string		Base pipeline template (org/name@version) this pipeline overrides by name.
`on`	`push` \| `pull_request` \| `tag` \| `manual` \| `api` \| `pipeline` \| `release` \| `webhook` or list of `push` \| `pull_request` \| `tag` \| `manual` \| `api` \| `pipeline` \| `release` \| `webhook` or on (triggers object)		Triggers that start the pipeline.
`inputs`	map of Input
`env`	map of string \| number \| boolean		Pipeline-wide environment variables (strings; expressions allowed).
`defaults`	defaults
`concurrency`	string or concurrency		Pipeline-level concurrency group.
`permissions`	`read-all` \| `write-all` or object		Scopes of the job OIDC token.
`permissions.contents`	`none` \| `read` \| `write`
`permissions.artifacts`	`none` \| `read` \| `write`
`permissions.secrets`	`none` \| `read` \| `write`
`permissions.deployments`	`none` \| `read` \| `write`
`permissions.id_token`	`none` \| `read` \| `write`
`stages`	list of Stage		Ordered stages; the job DAG is derived from needs. Mutually exclusive with jobs.
`jobs`	list of Job		Shorthand for a single implicit stage. Mutually exclusive with stages.

Triggers: on, inputs.
Stages and jobs: stages, jobs, containers, services, caches, artifacts, retry, concurrency, environments.
Steps: run, uses, template.