Options
All
  • Public
  • Public/Protected
  • All
Menu

A CircleCI configuration. Instantiate a new config and add CircleCI config elements.

Hierarchy

  • Config

Implements

Index

Constructors

constructor

  • Instantiate a new CircleCI config. Build up your config by adding components.

    Parameters

    • setup: boolean = false
    • Optional jobs: Job[]

      Instantiate with pre-defined Jobs.

    • Optional workflows: Workflow[]

      Instantiate with pre-defined Workflows.

    • Optional commands: Command[]

      Instantiate with pre-defined reusable Commands.

    Returns Config

Properties

commands

commands: Command[] = []

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.

jobs

jobs: Job[] = []

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.

pipeline

pipeline: Pipeline = ...

Access information about the current pipeline.

setup

setup: boolean

Designates the config.yaml for use of CircleCI’s dynamic configuration feature.

version

version: ConfigVersion = 2.1

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

workflows

workflows: Workflow[] = []

A Workflow is comprised of one or more uniquely named jobs.

Methods

addJob

addWorkflow

Private prependVersionComment

  • prependVersionComment(source: string): string

stringify

  • stringify(): string

Generated using TypeDoc