io.github.cdklabs.projen.javascript

Class UpgradeDependenciesWorkflowOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.UpgradeDependenciesWorkflowOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UpgradeDependenciesWorkflowOptions>

Enclosing interface:

UpgradeDependenciesWorkflowOptions

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

A builder for UpgradeDependenciesWorkflowOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UpgradeDependenciesWorkflowOptions.Builder	branches(List<String> branches) Sets the value of UpgradeDependenciesWorkflowOptions.getBranches()
UpgradeDependenciesWorkflowOptions	build() Builds the configured instance.
UpgradeDependenciesWorkflowOptions.Builder	container(ContainerOptions container) Sets the value of UpgradeDependenciesWorkflowOptions.getContainer()
UpgradeDependenciesWorkflowOptions.Builder	gitIdentity(GitIdentity gitIdentity) Sets the value of UpgradeDependenciesWorkflowOptions.getGitIdentity()
UpgradeDependenciesWorkflowOptions.Builder	labels(List<String> labels) Sets the value of UpgradeDependenciesWorkflowOptions.getLabels()
UpgradeDependenciesWorkflowOptions.Builder	rebuild(Boolean rebuild) Sets the value of UpgradeDependenciesWorkflowOptions.getRebuild()
UpgradeDependenciesWorkflowOptions.Builder	runsOn(List<String> runsOn) Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOn()
UpgradeDependenciesWorkflowOptions.Builder	schedule(UpgradeDependenciesSchedule schedule) Sets the value of UpgradeDependenciesWorkflowOptions.getSchedule()
UpgradeDependenciesWorkflowOptions.Builder	secret(String secret) Sets the value of UpgradeDependenciesWorkflowOptions.getSecret()

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

branches

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder branches(List<String> branches)

Sets the value of UpgradeDependenciesWorkflowOptions.getBranches()

Parameters:

branches - List of branches to create PR's for.

Returns:

this

container

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder container(ContainerOptions container)

Sets the value of UpgradeDependenciesWorkflowOptions.getContainer()

Parameters:

container - Job container options.

Returns:

this

gitIdentity

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder gitIdentity(GitIdentity gitIdentity)

Sets the value of UpgradeDependenciesWorkflowOptions.getGitIdentity()

Parameters:

gitIdentity - The git identity to use for commits.

Returns:

this

labels

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder labels(List<String> labels)

Sets the value of UpgradeDependenciesWorkflowOptions.getLabels()

Parameters:

labels - Labels to apply on the PR.

Returns:

this

rebuild

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder rebuild(Boolean rebuild)

Sets the value of UpgradeDependenciesWorkflowOptions.getRebuild()

Parameters:

rebuild - Execute 'build' after the upgrade. When true, the workflow will run the project build task after the dependency upgrade. This means that the PR created will include any changes caused by the build command, (e.g project synth changes, test snapshots)

This is necessary when using the default github token.

Returns:

this

runsOn

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder runsOn(List<String> runsOn)

Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

schedule

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder schedule(UpgradeDependenciesSchedule schedule)

Sets the value of UpgradeDependenciesWorkflowOptions.getSchedule()

Parameters:

schedule - Schedule to run on.

Returns:

this

secret

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions.Builder secret(String secret)

Sets the value of UpgradeDependenciesWorkflowOptions.getSecret()

Parameters:

secret - Which secret to use when creating the PR. When using the default github token, PR's created by this workflow will not trigger any subsequent workflows (i.e the build workflow). This is why this workflow also runs 'build' by default, and manually updates the status check of the PR.

If you pass a token that has the workflow permissions, you can skip running build in this workflow by specifying rebuild: false.

Returns:

this

build

@Stability(value=Experimental)
public UpgradeDependenciesWorkflowOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UpgradeDependenciesWorkflowOptions

Throws:

NullPointerException - if any required attribute was not provided