Package io.github.cdklabs.projen.javascript

Class BuildWorkflowOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.BuildWorkflowOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BuildWorkflowOptions>

Enclosing interface:

BuildWorkflowOptions

@Stability(Experimental)
public static final class BuildWorkflowOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BuildWorkflowOptions>

A builder for BuildWorkflowOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BuildWorkflowOptions	build()	Builds the configured instance.
BuildWorkflowOptions.Builder	mutableBuild(Boolean mutableBuild)	Sets the value of BuildWorkflowOptions.getMutableBuild()
BuildWorkflowOptions.Builder	name(String name)	Sets the value of BuildWorkflowCommonOptions.getName()
BuildWorkflowOptions.Builder	permissions(JobPermissions permissions)	Sets the value of BuildWorkflowCommonOptions.getPermissions()
BuildWorkflowOptions.Builder	preBuildSteps(List<? extends JobStep> preBuildSteps)	Sets the value of BuildWorkflowCommonOptions.getPreBuildSteps()
BuildWorkflowOptions.Builder	workflowTriggers(Triggers workflowTriggers)	Sets the value of BuildWorkflowCommonOptions.getWorkflowTriggers()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

mutableBuild

@Stability(Experimental)
public BuildWorkflowOptions.Builder mutableBuild(Boolean mutableBuild)

Sets the value of BuildWorkflowOptions.getMutableBuild()

Parameters:

mutableBuild - Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

Implies that PR builds do not have anti-tamper checks.

Returns:

this

name

@Stability(Experimental)
public BuildWorkflowOptions.Builder name(String name)

Sets the value of BuildWorkflowCommonOptions.getName()

Parameters:

name - Name of the buildfile (e.g. "build" becomes "build.yml").

Returns:

this

permissions

@Stability(Experimental)
public BuildWorkflowOptions.Builder permissions(JobPermissions permissions)

Sets the value of BuildWorkflowCommonOptions.getPermissions()

Parameters:

permissions - Permissions granted to the build job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

Returns:

this

preBuildSteps

@Stability(Experimental)
public BuildWorkflowOptions.Builder preBuildSteps(List<? extends JobStep> preBuildSteps)

Sets the value of BuildWorkflowCommonOptions.getPreBuildSteps()

Parameters:

preBuildSteps - Steps to execute before the build.

Returns:

this

workflowTriggers

@Stability(Experimental)
public BuildWorkflowOptions.Builder workflowTriggers(Triggers workflowTriggers)

Sets the value of BuildWorkflowCommonOptions.getWorkflowTriggers()

Parameters:

workflowTriggers - Build workflow triggers.

Returns:

this

build

@Stability(Experimental)
public BuildWorkflowOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BuildWorkflowOptions>

Returns:

a new instance of BuildWorkflowOptions

Throws:

NullPointerException - if any required attribute was not provided