YAML

reference information for creating Vela pipelines

Steps and Stages Pipeline use “YAML Ain’t Markup Language” (YAML) which is a data serialization language designed to be human friendly. Vela accepts YAML files with either a .yml or .yaml extension. If you’d like to learn more about the YAML language, we recommend you see, “Learn YAML in five minutes.”.

Terminology Check

Whether you are a YAML expert or a novice, here is some quick terminology that you should be aware of:

Document

A file ending with .yml or .yaml that contains contents following the YAML spec is called a document, see YAML 1.2 spec for full details.

Example:

---
key: value

Tags

A YAML document is compose of one to many key-value pairs where the key is called the tag and the value is evaluated to an explicit type (Int, Float, string, bool, etc), see YAML 1.2 spec for full details.

Example:

---
# an integer
canonical: 12345

# a float
canonical: 3.14159e+3

# a string
canonical: "Hello, World"

# a bool
canonical: true

Environment

YAML tags for environment block

Version

YAML tags for version block

Metadata

YAML tags for metadata block

Worker

YAML tags for worker block

Templates

YAML tags for templates block

Services

YAML tags for services block

Steps

YAML tags for steps block

Stages

YAML stages for stages block

Secrets

YAML tags for secret block

Last modified February 1, 2021: feat(ref): add a yaml section (#196) (9d7fdaf8)