Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/circleci-config-yml/_shared/latest--schema.json
Parent schema circleci-config-yml
Type: object

Properties

version enum required

The version field is intended to be used in order to issue warnings for deprecation or breaking changes.

Values: "2.1" 2.1
executors Record<string, object | string>

Executors define the environment in which the steps of a job will be run, allowing you to reuse a single executor definition across multiple jobs.

experimental object
1 nested properties
notify object required
1 nested properties
branches object required

A map defining rules for execution on specific branches

2 nested properties
only string | string[]

Either a single branch specifier, or a list of branch specifiers

ignore string | string[]

Either a single branch specifier, or a list of branch specifiers

workflows Record<string, object>

Used for orchestrating all jobs. Each workflow consists of the workflow name as a key and a map as a value

1 nested properties
version number | string

The Workflows version field is used to issue warnings for deprecation or breaking changes during v2 Beta. It is deprecated as of CircleCI v2.1

jobs Record<string, string | object>

Jobs are collections of steps. All of the steps in the job are executed in a single unit, either within a fresh container or VM.

orbs Record<string, string | string | object>

https://circleci.com/docs/configuration-reference#orbs-requires-version-21

Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.

commands Record<string, object | string>

https://circleci.com/docs/configuration-reference#commands-requires-version-21

A command definition defines a sequence of steps as a map to be executed in a job, enabling you to reuse a single command definition across multiple jobs.

examples Record<string, object>
display object
2 nested properties
home_url string
source_url string
parameters Record<string, object>

Definitions

jobInvocation string | object
orb string | object
environment string | null | environment[] | object
logic string | boolean | number | string | object | object
step string | object | object