Package io.github.cdklabs.projen.circleci

Class Circleci

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.circleci.Circleci

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.059Z")
@Stability(Experimental)
public class Circleci
extends Component

(experimental) Circleci Class to manage .circleci/config.yml. Check projen's docs for more information.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Circleci.Builder	(experimental) A fluent builder for Circleci.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Circleci(Project project)
	Circleci(Project project, CircleCiProps options)
protected	Circleci(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Circleci(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addOrb(String name, String orb)	(experimental) Add a Circleci Orb to pipeline.
void	addWorkflow(Workflow workflow)	(experimental) add new workflow to existing pipeline.
YamlFile	getFile()	(experimental) The yaml file for the Circleci pipeline.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Circleci

protected Circleci(software.amazon.jsii.JsiiObjectRef objRef)

Circleci

protected Circleci(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Circleci

@Stability(Experimental)
public Circleci(@NotNull
                Project project,
                @Nullable
                CircleCiProps options)

Parameters:

project - This parameter is required.

options -

Circleci

@Stability(Experimental)
public Circleci(@NotNull
                Project project)

Parameters:

project - This parameter is required.

Method Detail

addOrb

@Stability(Experimental)
public void addOrb(@NotNull
                   String name,
                   @NotNull
                   String orb)

(experimental) Add a Circleci Orb to pipeline.

Will throw error if the orb already exists

Parameters:

name - This parameter is required.

orb - This parameter is required.

addWorkflow

@Stability(Experimental)
public void addWorkflow(@NotNull
                        Workflow workflow)

(experimental) add new workflow to existing pipeline.

Parameters:

workflow - This parameter is required.

getFile

@Stability(Experimental)
@NotNull
public YamlFile getFile()

(experimental) The yaml file for the Circleci pipeline.