Package io.github.cdklabs.projen.circleci

Interface CircleCiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CircleCiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.059Z")
@Stability(Experimental)
public interface CircleCiProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for class Circleci.

See Also:

https://circleci.com/docs/2.0/configuration-reference/

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CircleCiProps.Builder	A builder for CircleCiProps
static class	CircleCiProps.Jsii$Proxy	An implementation for CircleCiProps

Method Summary

Modifier and Type	Method	Description
static CircleCiProps.Builder	builder()
default List<Job>	getJobs()	(experimental) List of Jobs to create unique steps per pipeline, e.g.
default Map<String,String>	getOrbs()	(experimental) Contains a map of CirclCi Orbs json orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" } .
default Boolean	getSetup()	(experimental) The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.
default Number	getVersion()	(experimental) pipeline version.
default List<Workflow>	getWorkflows()	(experimental) List of Workflows of pipeline, e.g.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJobs

@Stability(Experimental)
@Nullable
default List<Job> getJobs()

(experimental) List of Jobs to create unique steps per pipeline, e.g. json jobs: [{ identifier: "compile", docker: { image: "golang:alpine" } steps: ["checkout", run: {command: "go build ."}] }] .

See Also:

https://circleci.com/docs/2.0/configuration-reference/#jobs

getOrbs

@Stability(Experimental)
@Nullable
default Map<String,String> getOrbs()

(experimental) Contains a map of CirclCi Orbs json orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" } .

getSetup

@Stability(Experimental)
@Nullable
default Boolean getSetup()

(experimental) The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.

See Also:

https://circleci.com/docs/2.0/configuration-reference/#setup

getVersion

@Stability(Experimental)
@Nullable
default Number getVersion()

(experimental) pipeline version.

Default: 2.1

See Also:

https://circleci.com/docs/2.0/configuration-reference/#version

getWorkflows

@Stability(Experimental)
@Nullable
default List<Workflow> getWorkflows()

(experimental) List of Workflows of pipeline, e.g. json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } } .

See Also:

https://circleci.com/docs/2.0/configuration-reference/#workflows

builder

@Stability(Experimental)
static CircleCiProps.Builder builder()

Returns:

a CircleCiProps.Builder of CircleCiProps