Vela Pipeline Configuration

Vela Pipeline Configuration File

Type object
File match .vela.yml .vela.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/vela-pipeline-configuration/latest.json
Source https://github.com/go-vela/server/releases/latest/download/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

version string required

Provide syntax version used to evaluate the pipeline. Reference: https://go-vela.github.io/docs/reference/yaml/version/

minLength=1
metadata object
5 nested properties
template boolean

Enables compiling the pipeline as a template. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-template-key

render_inline boolean

Enables inline compiling for the pipeline templates. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-render-inline-key

clone boolean

Enables injecting the default clone process. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-clone-key

Default: true
environment string[]

Controls which containers processes can have global env injected. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-environment-key

auto_cancel object
3 nested properties
running boolean

Enables auto canceling of running pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

pending boolean

Enables auto canceling of queued pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

default_branch boolean

Enables auto canceling of queued or running pipelines that become stale due to new push to default branch. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

environment string[] | object
worker object
2 nested properties
flavor string

Flavor identifier for worker. Reference: https://go-vela.github.io/docs/reference/yaml/worker/#the-flavor-key

Examples: "large"
minLength=1
platform string

Platform identifier for the worker. Reference: https://go-vela.github.io/docs/reference/yaml/worker/#the-platform-key

Examples: "kubernetes"
minLength=1
secrets Secret[]
services Service[]
stages object
steps Step[]
templates Template[]
deployment object
3 nested properties
targets string | string[]
parameters Record<string, object>
template object
2 nested properties
name string required

Unique identifier for the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

minLength=1
vars object

Variables injected into the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

git object
1 nested properties
token object
2 nested properties
repositories string[]

Provide a list of repositories to clone. Reference: https://go-vela.github.io/docs/reference/yaml/git/#repositories

permissions Record<string, string>

Provide a list of repository permissions to apply to the git token. Reference: https://go-vela.github.io/docs/reference/yaml/git/#permissions

One of

1. stages
2. steps

Definitions

Artifacts object
paths string | string[]
CancelOptions object
running boolean

Enables auto canceling of running pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

pending boolean

Enables auto canceling of queued pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

default_branch boolean

Enables auto canceling of queued or running pipelines that become stale due to new push to default branch. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

Deployment object
targets string | string[]
parameters Record<string, object>
template object
2 nested properties
name string required

Unique identifier for the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

minLength=1
vars object

Variables injected into the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

Git object
token object
2 nested properties
repositories string[]

Provide a list of repositories to clone. Reference: https://go-vela.github.io/docs/reference/yaml/git/#repositories

permissions Record<string, string>

Provide a list of repository permissions to apply to the git token. Reference: https://go-vela.github.io/docs/reference/yaml/git/#permissions

Metadata object
template boolean

Enables compiling the pipeline as a template. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-template-key

render_inline boolean

Enables inline compiling for the pipeline templates. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-render-inline-key

clone boolean

Enables injecting the default clone process. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-clone-key

Default: true
environment string[]

Controls which containers processes can have global env injected. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-environment-key

auto_cancel object
3 nested properties
running boolean

Enables auto canceling of running pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

pending boolean

Enables auto canceling of queued pipelines that become stale due to new push. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

default_branch boolean

Enables auto canceling of queued or running pipelines that become stale due to new push to default branch. Reference: https://go-vela.github.io/docs/reference/yaml/metadata/#the-auto-cancel-key

Origin object
image string required

Docker image to use to create the ephemeral container. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-image-key

minLength=1
name string required

Unique name for the secret origin. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-name-key

minLength=1
environment string[] | object
parameters object

Extra configuration variables for the secret plugin. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-parameters-key

secrets StepSecret[]
pull string

Declaration to configure if and when the Docker image is pulled. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-pull-key

Default: "not_present"
Values: "always" "not_present" "on_start" "never"
ruleset object | object
id_request string

Request ID Request Token for the secret origin. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-id_request-key

Parameter object
description string

Description of the parameter. Reference: https://go-vela.github.io/docs/reference/yaml/deployments/#the-parameters-key

type string

Type of the parameter. Reference: https://go-vela.github.io/docs/reference/yaml/deployments/#the-parameters-key

required boolean

Flag indicating if the parameter is required. Reference: https://go-vela.github.io/docs/reference/yaml/deployments/#the-parameters-key

options string | string[]
min integer

Minimum value for the parameter. Reference: https://go-vela.github.io/docs/reference/yaml/deployments/#the-parameters-key

max integer

Maximum value for the parameter. Reference: https://go-vela.github.io/docs/reference/yaml/deployments/#the-parameters-key

ParameterMap Record<string, object>
Rules object
branch string[] | string

Limits the execution of a step to matching build branches. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

comment string[] | string

Limits the execution of a step to matching a pull request comment. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

event string[] | string

Limits the execution of a step to matching build events. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

path string[] | string

Limits the execution of a step to matching files changed in a repository. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

repo string[] | string

Limits the execution of a step to matching repos. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

sender string[] | string

Limits the execution of a step to matching build senders. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

status string[] | string

Limits the execution of a step to matching build statuses. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

tag string[] | string

Limits the execution of a step to matching build tag references. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

target string[] | string

Limits the execution of a step to matching build deployment targets. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

label string[] | string

Limits step execution to match on pull requests labels. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

instance string[] | string

Limits step execution to match on certain instances. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

eval string | string

The expression to evaluate the ruleset against. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

operator string

Whether all rule conditions must be met or just any one of them. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

Default: "and"
Values: "or" "and"
matcher string

Use the defined matching method. Reference: coming soon

Default: "filepath"
Values: "filepath" "regexp"
continue boolean

Limits the execution of a step to continuing on any failure. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-ruleset-key

Default: false
Ruleset object | object
Secret object | object
SecretSlice Secret[]
Service object
image string required

Docker image used to create ephemeral container. Reference: https://go-vela.github.io/docs/reference/yaml/services/#the-image-key

minLength=1
name string required

Unique identifier for the container in the pipeline. Reference: https://go-vela.github.io/docs/reference/yaml/services/#the-name-key

minLength=1
entrypoint string | string[]
environment string[] | object
ports string | string[]
pull string

Declaration to configure if and when the Docker image is pulled. Reference: https://go-vela.github.io/docs/reference/yaml/services/#the-pul-key

Default: "not_present"
Values: "always" "not_present" "on_start" "never"
ulimits Ulimit[]
user string

Set the user for the container. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-user-key

ruleset object | object
ServiceSlice Service[]
Stage object
steps Step[] required
environment string[] | object
name string

Unique identifier for the stage in the pipeline. Reference: https://go-vela.github.io/docs/reference/yaml/stages/#the-name-key

minLength=1
needs string | string[]
independent boolean

Stage will continue executing if other stage fails

StageSlice object
Step object
name string required

Unique name for the step. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-name-key

minLength=1
ruleset object | object
commands string | string[]
entrypoint string | string[]
secrets StepSecret[]
template object
2 nested properties
name string required

Unique identifier for the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

minLength=1
vars object

Variables injected into the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

artifacts object
1 nested properties
paths string | string[]
ulimits Ulimit[]
volumes Volume[]
image string

Docker image to use to create the ephemeral container. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-image-key

minLength=1
pull string

Declaration to configure if and when the Docker image is pulled. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-pull-key

Default: "not_present"
Values: "always" "not_present" "on_start" "never"
environment string[] | object
parameters object

Extra configuration variables for a plugin. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-parameters-key

detach boolean

Run the container in a detached (headless) state. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-detach-key

privileged boolean

Run the container with extra privileges. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-privileged-key

user string

Set the user for the container. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-user-key

report_as string

Set the name of the step to report as. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-report_as-key

id_request string

Request ID Request Token for the step. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-id_request-key

git object
1 nested properties
token object
2 nested properties
repositories string[]

Provide a list of repositories to clone. Reference: https://go-vela.github.io/docs/reference/yaml/git/#repositories

permissions Record<string, string>

Provide a list of repository permissions to apply to the git token. Reference: https://go-vela.github.io/docs/reference/yaml/git/#permissions

StepSecret string | object
StepSecretSlice StepSecret[]
StepSlice Step[]
StepTemplate object
name string required

Unique identifier for the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

minLength=1
vars object

Variables injected into the template. Reference: https://go-vela.github.io/docs/reference/yaml/steps/#the-template-key

StringSlice string | string[]
StringSliceMap string[] | object
Template object
name string required

Unique identifier for the template. Reference: https://go-vela.github.io/docs/reference/yaml/templates/#the-name-key

minLength=1
source string required

Path to template in remote system. Reference: https://go-vela.github.io/docs/reference/yaml/templates/#the-source-key

minLength=1
format string

language used within the template file Reference: https://go-vela.github.io/docs/reference/yaml/templates/#the-format-key

Default: "go"
Values: "starlark" "golang" "go"
minLength=1
type string

Type of template provided from the remote system. Reference: https://go-vela.github.io/docs/reference/yaml/templates/#the-type-key

Values: "github" "file"
Examples: "github"
minLength=1
vars object

Variables injected into the template. Reference: https://go-vela.github.io/docs/reference/yaml/templates/#the-variables-key

TemplateSlice Template[]
Token object
repositories string[]

Provide a list of repositories to clone. Reference: https://go-vela.github.io/docs/reference/yaml/git/#repositories

permissions Record<string, string>

Provide a list of repository permissions to apply to the git token. Reference: https://go-vela.github.io/docs/reference/yaml/git/#permissions

Ulimit string | object
UlimitSlice Ulimit[]
Volume string | object
VolumeSlice Volume[]
Worker object
flavor string

Flavor identifier for worker. Reference: https://go-vela.github.io/docs/reference/yaml/worker/#the-flavor-key

Examples: "large"
minLength=1
platform string

Platform identifier for the worker. Reference: https://go-vela.github.io/docs/reference/yaml/worker/#the-platform-key

Examples: "kubernetes"
minLength=1