Woodpecker pipeline config (SchemaStore) JSON Schema

Type	object
File match	`/.woodpecker/.yml` `/.woodpecker.yml` `/.woodpecker/.yaml` `/.woodpecker.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/woodpecker-pipeline-config/latest.json
Source	https://raw.githubusercontent.com/woodpecker-ci/woodpecker/main/pipeline/frontend/yaml/linter/schema/schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Schema of a Woodpecker pipeline file. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax

Properties

steps object | step[] required

The steps section defines a list of steps which will be executed serially, in the order in which they are defined. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps

$schema string

format=uri

variables

Use yaml aliases to define variables. Read more: https://woodpecker-ci.org/docs/usage/advanced-usage

clone object | step[]

Configures the clone step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone

skip_clone boolean

when workflow_when_condition[] | workflow_when_condition

Whole workflow can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions

services object | service[]

workspace object

matrix Record<string, boolean | string | number[]>

Execute pipeline for each matrix combination. Read more: https://woodpecker-ci.org/docs/usage/matrix-workflows

1 nested properties

include object[]

minLength=1

labels Record<string, boolean | string | number>

Configures the labels used for the agent selection. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#labels

depends_on string[]

minLength=1

runs_on string[]

Deprecated: use when.status instead. Read more: https://woodpecker-ci.org/docs/usage/workflows#flow-control

minLength=1

Definitions

string_or_string_slice string[] | string

clone object | step[]

Configures the clone step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone

clone_settings Record<string, boolean | string | number | array | object>

Change the settings of your clone plugin. Read more: https://woodpecker-ci.org/plugins/git-clone

depth number

If specified, uses git's --depth option to create a shallow clone with a limited number of commits, overwritten by partial

recursive boolean

Clones submodules recursively

Default: false

partial boolean

Only fetch the one commit and it's blob objects to resolve all files, overwrite depth with 1

lfs boolean

Set this to false to disable retrieval of LFS files

Default: true

tags boolean

Fetches tags when set to true, default is false if event is not tag else true

step_list object | step[]

The steps section defines a list of steps which will be executed serially, in the order in which they are defined. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps

workflow_when workflow_when_condition[] | workflow_when_condition

Whole workflow can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---global-workflow-conditions

workflow_when_condition object

repo string | string[] | object

branch string | string[] | object

event event_enum | event_enum[]

ref string | string[] | object

cron string | string[] | object

status string[] | string

platform string | string[] | object

instance string | string[] | object

path string | string[] | object

Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#path

evaluate string

Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate

step commands_step | plugin_step

A step of your workflow executes either arbitrary commands or uses a plugin. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps

commands_step object

Every step of your pipeline executes arbitrary commands inside a specified docker container. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#steps

image string required

name string

The name of the step. Can be used if using the array style steps list.

privileged boolean

Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/next/usage/workflow-syntax#privileged-mode

Default: false

pull boolean

Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image

commands string[] | string

Commands of every pipeline step are executed serially as if you would enter them into your local shell. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#commands

environment Record<string, boolean | string | number | array | object>

Pass environment variables to a pipeline step. Read more: https://woodpecker-ci.org/docs/usage/environment

directory string

when step_when_condition[] | step_when_condition

Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---conditional-execution

volumes string[]

Mount files or folders from the host machine into your step container. Read more: https://woodpecker-ci.org/docs/usage/volumes

minLength=1

depends_on string[] | string

detach boolean

Detach a step to run in background until pipeline finishes. Read more: https://woodpecker-ci.org/docs/usage/services#detachment

failure string

How to handle the failure of this step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#failure

Default: "fail"

Values: "fail" "ignore" "cancel"

backend_options object

Advanced options for the different agent backends

1 nested properties

kubernetes object

Advanced options for the kubernetes agent backends

6 nested properties

labels Record<string, boolean | string | number>

annotations Record<string, boolean | string | number>

tolerations step_backend_kubernetes_toleration_object[]

The tolerations section defines a list of references to the native Kubernetes tolerations. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#tolerations

minLength=1

securityContext object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

runtimeClassName string

secrets step_kubernetes_secret[]

The secrets section defines a list of references to the native Kubernetes secrets

minLength=1

entrypoint string[] | string

dns string[] | string

dns_search string[] | string

plugin_step object

Plugins let you execute predefined functions in a more secure context. Read more: https://woodpecker-ci.org/docs/usage/plugins/overview

image string required

name string

The name of the step. Can be used if using the array style steps list.

privileged boolean

Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/next/usage/workflow-syntax#privileged-mode

Default: false

pull boolean

Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image

directory string

settings Record<string, boolean | string | number | array | object>

Change the settings of your plugin. Read more: https://woodpecker-ci.org/docs/usage/plugins/overview

when step_when_condition[] | step_when_condition

Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---conditional-execution

volumes string[]

Mount files or folders from the host machine into your step container. Read more: https://woodpecker-ci.org/docs/usage/volumes

minLength=1

depends_on string[] | string

detach boolean

Detach a step to run in background until pipeline finishes. Read more: https://woodpecker-ci.org/docs/usage/services#detachment

failure string

How to handle the failure of this step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#failure

Default: "fail"

Values: "fail" "ignore"

backend_options object

Advanced options for the different agent backends

1 nested properties

kubernetes object

Advanced options for the kubernetes agent backends

6 nested properties

labels Record<string, boolean | string | number>

annotations Record<string, boolean | string | number>

tolerations step_backend_kubernetes_toleration_object[]

The tolerations section defines a list of references to the native Kubernetes tolerations. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#tolerations

minLength=1

securityContext object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

runtimeClassName string

secrets step_kubernetes_secret[]

The secrets section defines a list of references to the native Kubernetes secrets

minLength=1

step_when step_when_condition[] | step_when_condition

Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---conditional-execution

step_when_condition object

repo string | string[] | object

branch string | string[] | object

event event_enum | event_enum[]

ref string | string[] | object

cron string | string[] | object

status string[] | string

platform string | string[] | object

matrix Record<string, boolean | string | number>

instance string | string[] | object

path string | string[] | object

Execute a step only on commit with certain files added/removed/modified. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#path

evaluate string

Execute a step only if the expression evaluates to true. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#evaluate

event_enum enum

event_constraint_list event_enum | event_enum[]

constraint_list string | string[] | object

step_image string

step_privileged boolean

Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/next/usage/workflow-syntax#privileged-mode

step_pull boolean

Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image

step_commands string[] | string

Commands of every pipeline step are executed serially as if you would enter them into your local shell. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#commands

step_environment Record<string, boolean | string | number | array | object>

Pass environment variables to a pipeline step. Read more: https://woodpecker-ci.org/docs/usage/environment

step_settings Record<string, boolean | string | number | array | object>

Change the settings of your plugin. Read more: https://woodpecker-ci.org/docs/usage/plugins/overview

step_volumes string[]

Mount files or folders from the host machine into your step container. Read more: https://woodpecker-ci.org/docs/usage/volumes

step_directory string

step_backend_options object

Advanced options for the different agent backends

kubernetes object

Advanced options for the kubernetes agent backends

6 nested properties

labels Record<string, boolean | string | number>

annotations Record<string, boolean | string | number>

tolerations step_backend_kubernetes_toleration_object[]

The tolerations section defines a list of references to the native Kubernetes tolerations. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#tolerations

minLength=1

securityContext object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

7 nested properties

privileged boolean

runAsNonRoot boolean

runAsUser number

runAsGroup number

fsGroup number

seccompProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

apparmorProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

runtimeClassName string

secrets step_kubernetes_secret[]

The secrets section defines a list of references to the native Kubernetes secrets

minLength=1

step_backend_kubernetes object

Advanced options for the kubernetes agent backends

labels Record<string, boolean | string | number>

annotations Record<string, boolean | string | number>

tolerations step_backend_kubernetes_toleration_object[]

The tolerations section defines a list of references to the native Kubernetes tolerations. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#tolerations

minLength=1

securityContext object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

7 nested properties

privileged boolean

runAsNonRoot boolean

runAsUser number

runAsGroup number

fsGroup number

seccompProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

2 nested properties

type string

localhostProfile string

apparmorProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

2 nested properties

type string

localhostProfile string

runtimeClassName string

secrets step_kubernetes_secret[]

The secrets section defines a list of references to the native Kubernetes secrets

minLength=1

step_backend_kubernetes_resources object

Resources for the kubernetes backend. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

requests Record<string, string>

A list of kubernetes resource mappings

limits Record<string, string>

A list of kubernetes resource mappings

step_backend_kubernetes_security_context object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

privileged boolean

runAsNonRoot boolean

runAsUser number

runAsGroup number

fsGroup number

seccompProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

2 nested properties

type string

localhostProfile string

apparmorProfile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

2 nested properties

type string

localhostProfile string

step_backend_kubernetes_secprofile object

Pods / containers security profile. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#step-specific-configuration

type string

localhostProfile string

step_kubernetes_resources_object Record<string, string>

A list of kubernetes resource mappings

step_backend_kubernetes_service_account object

serviceAccountName to be use by job. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#service-account

requests Record<string, string>

A list of kubernetes resource mappings

limits Record<string, string>

A list of kubernetes resource mappings

step_kubernetes_service_account_object Record<string, string>

A list of kubernetes resource mappings

step_kubernetes_secret object

A reference to a native Kubernetes secret

name string

The name of the secret. Can be used if using the array style secrets list.

key string

The key of the secret to select from.

target object | object

A target which a native Kubernetes secret maps to.

step_kubernetes_secret_target object | object

A target which a native Kubernetes secret maps to.

step_backend_kubernetes_toleration_object object

Toleration entry for the kubernetes backend.

key string

operator string

value string

effect string

tolerationSeconds integer

services object | service[]

service object

image string required

name string

The name of the service. Can be used if using the array style services list

privileged boolean

Run the step in privileged mode. Read more: https://woodpecker-ci.org/docs/next/usage/workflow-syntax#privileged-mode

Default: false

pull boolean

Always pull the latest image on pipeline execution Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#image

commands string[] | string

Commands of every pipeline step are executed serially as if you would enter them into your local shell. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#commands

environment Record<string, boolean | string | number | array | object>

Pass environment variables to a pipeline step. Read more: https://woodpecker-ci.org/docs/usage/environment

directory string

settings Record<string, boolean | string | number | array | object>

Change the settings of your plugin. Read more: https://woodpecker-ci.org/docs/usage/plugins/overview

when step_when_condition[] | step_when_condition

Steps can be skipped based on conditions. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#when---conditional-execution

volumes string[]

Mount files or folders from the host machine into your step container. Read more: https://woodpecker-ci.org/docs/usage/volumes

minLength=1

failure string

How to handle the failure of this step. Read more: https://woodpecker-ci.org/docs/usage/services#stopping

Default: "fail"

Values: "fail" "ignore"

backend_options object

Advanced options for the different agent backends

1 nested properties

kubernetes object

Advanced options for the kubernetes agent backends

6 nested properties

labels Record<string, boolean | string | number>

annotations Record<string, boolean | string | number>

tolerations step_backend_kubernetes_toleration_object[]

The tolerations section defines a list of references to the native Kubernetes tolerations. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#tolerations

minLength=1

securityContext object

Pods / containers security context. Read more: https://woodpecker-ci.org/docs/administration/configuration/backends/kubernetes#security-context

runtimeClassName string

secrets step_kubernetes_secret[]

The secrets section defines a list of references to the native Kubernetes secrets

minLength=1

ports number | string[]

expose ports to which other steps can connect to

minLength=1

workspace object

matrix Record<string, boolean | string | number[]>

Execute pipeline for each matrix combination. Read more: https://woodpecker-ci.org/docs/usage/matrix-workflows

include object[]

minLength=1

labels Record<string, boolean | string | number>

Configures the labels used for the agent selection. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#labels