Class Circleci.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.circleci.Circleci.Builder
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Circlecibuild()static Circleci.Buildercreate(Project project)Circleci.Builderjobs(List<? extends Job> jobs)(experimental) List of Jobs to create unique steps per pipeline, e.g.Circleci.Builderorbs(Map<String,String> orbs)(experimental) Contains a map of CirclCi Orbsjson orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" }.Circleci.Buildersetup(Boolean setup)(experimental) The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.Circleci.Builderversion(Number version)(experimental) pipeline version.Circleci.Builderworkflows(List<? extends Workflow> workflows)(experimental) List of Workflows of pipeline, e.g.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static Circleci.Builder create(Project project)
- Parameters:
project- This parameter is required.- Returns:
- a new instance of
Circleci.Builder.
-
jobs
@Stability(Experimental) public Circleci.Builder jobs(List<? extends Job> jobs)
(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 ."}] }].- Parameters:
jobs- 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 ."}] }]. This parameter is required.- Returns:
this- See Also:
- https://circleci.com/docs/2.0/configuration-reference/#jobs
-
orbs
@Stability(Experimental) public Circleci.Builder orbs(Map<String,String> orbs)
(experimental) Contains a map of CirclCi Orbsjson orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" }.- Parameters:
orbs- Contains a map of CirclCi Orbsjson orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" }. This parameter is required.- Returns:
this
-
setup
@Stability(Experimental) public Circleci.Builder setup(Boolean setup)
(experimental) The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.- Parameters:
setup- The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations. This parameter is required.- Returns:
this- See Also:
- https://circleci.com/docs/2.0/configuration-reference/#setup
-
version
@Stability(Experimental) public Circleci.Builder version(Number version)
(experimental) pipeline version.Default: 2.1
- Parameters:
version- pipeline version. This parameter is required.- Returns:
this- See Also:
- https://circleci.com/docs/2.0/configuration-reference/#version
-
workflows
@Stability(Experimental) public Circleci.Builder workflows(List<? extends Workflow> workflows)
(experimental) List of Workflows of pipeline, e.g.json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } }.- Parameters:
workflows- List of Workflows of pipeline, e.g.json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } }. This parameter is required.- Returns:
this- See Also:
- https://circleci.com/docs/2.0/configuration-reference/#workflows
-
-