Instantiate a new CircleCI config. Build up your config by adding components.
Instantiate with pre-defined Jobs.
Instantiate with pre-defined Workflows.
Instantiate with pre-defined reusable Commands.
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.
Reusable executors to be referenced from jobs.
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.
A parameter allows custom data to be passed to a pipeline.
Access information about the current pipeline.
Designates the config.yaml for use of CircleCI’s dynamic configuration feature.
The version field is intended to be used in order to issue warnings for deprecation or breaking changes.
A Workflow is comprised of one or more uniquely named jobs.
Add a Custom Command to the current Config. Chainable
Injectable command
Add a Workflow to the current Config. Chainable
Define a pipeline parameter for the current Config. Chainable
The name of the parameter
The type of parameter
The default value of the parameter
A description of the parameter
An array of possible values for parameters of enum type
Attempt to remove unnecessary parameters when possible.
the CircleCI config as a JSON string
Attempt to remove unnecessary parameters when possible.
Modify the YAML output options.
the CircleCI config as a YAML string
Agnostic method to save a config file to disk via Node or the Browser. Note: If you are accessing this method from the browser, it must be triggered by a user action.
The path to write the config to. ONLY USED IN NODE.JS
Generated using TypeDoc
A CircleCI configuration. Instantiate a new config and add CircleCI config elements.