Config (pkg.pkl-lang.org/pkl-pantry/com.circleci.v2:1.1.0) • Packages

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

version: "2.1"Source

Version of the config.yml schema to target.

Currently, only version 2.1 is supported by this template.
link

setup: Boolean?Source

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

orbs: Mapping<String, (Orb|String)>?Source

A map of user-selected names to either: orb references (strings) or orb definitions (maps).

Orb definitions must be the orb-relevant subset of 2.1 config. See the Creating Orbs documentation for details.
link

executors: Mapping<String, Executor>?Source

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

See executors in the CircleCI documentation. Also see Using Workspaces to Share Data between Jobs for information on how to use executors to share state between jobs.
link

commands: Mapping<String, Command>?Source

A command 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.

For more information see the Reusable Config Reference Guide.
link

jobs: Mapping<String(matches(Regex("^[A-Za-z][A-Za-z\\s\\d_-]*$"))), Job>?Source

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

Jobs are specified in the jobs map, see Sample config.yml for two examples of a job map. The name of the job is the key in the map, and the value is a map describing the job.
link

workflows: Mapping<String, Workflow>?Source

Used for orchestrating all jobs.

Each workflow consists of the workflow name as a key and a map as a value. A name should be unique within the current config.yml. The top-level keys for the Workflows configuration are version and jobs. For more information, see the Using Workflows to Orchestrate Jobs page.
link

parameters: Mapping<String, Parameter>?Source

Pipeline parameters declared for use in the configuration.

See Pipeline Values and Parameters for usage details.
link

hidden

pipelineValues: PipelineValues Source

Pipeline values are available to all pipeline configurations and can be used without previous declaration.

For a full list of values and built-in environment variables, see the Project values and variables guide.

For more reference: https://circleci.com/docs/pipeline-variables/#pipeline-values

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

run(_command: String): RunStep Source

Classes

link

class

Orb Source
link

class

Executor Source
link

class

Job Source
link

class

MacOSExecutor Source
link

class

Machine Source
link

class

DockerImage Source
link

class

ScheduleTrigger Source
link

class

ScheduleTriggerFilter Source
link

class

ScheduleTriggerFilterBranches Source
link

class

Workflow Source
link

class

WorkflowJob Source
link

class

JobFilters Source
link

class

FilterSpec Source
link

class

RunStep extends AbstractStep Source

Used for invoking all command-line programs.
link

class

SaveCacheStep extends AbstractStep Source

Generates and stores a cache of a file or directory of files such as dependencies or source code in our object storage.
link

class

RestoreCacheStep extends AbstractStep Source

Restores a previously saved cache based on a key.
link

class

SetupRemoteDockerStep extends AbstractStep Source

Allows Docker commands to be run locally.
link

class

PersistToWorkspaceStep extends AbstractStep Source

Special step used to persist a temporary file to be used by another job in the workflow. For more information on using workspaces, see the Using Workspaces to Share Data Between Jobs page.
link

class

AttachWorkspaceStep extends AbstractStep Source

Special step used to attach the workflow’s workspace to the current container.
link

class

WhenStep Source

A conditional step consists of a step with the key when.
link

class

UnlessStep Source

A conditional step consists of a step with the key unless.
link

class

Command Source
link

class

Parameter Source
link

class

StoreTestResults extends AbstractStep Source

Special step used to upload and store test results for a build.
link

class

StoreArtifacts extends AbstractStep Source

Step to store artifacts (for example logs, binaries, etc) to be available in the web app or through the API.
link

class

LogicStatement Source

Certain dynamic configuration features accept logic statements as arguments.
link

class

Match Source
link

class

PipelineValues Source

Type Aliases

link

typealias

ResourceClass = "small"|"medium"|"medium+"|"large"|"xlarge"|"2xlarge"|"2xlarge+"|"arm.medium"|"arm.large"|"arm.xlarge"|"arm.2xlarge"|"macos.m1.medium.gen1"|"macos.m1.large.gen1"Source
link

typealias

Step = AbstractStep|SimpleStepName Source
link

typealias

SimpleStepName = "checkout"|"setup_remote_docker"|"add_ssh_keyes"|String Source
link

typealias

CalledCommand = Mapping<String, CommandCall>(length == 1)Source
link

typealias

CommandCall = Mapping<String, (String|Number|Boolean)>Source

com.circleci.v2.Config1.1.0

Properties(show inherited)

Methods(show inherited)

Classes

Type Aliases