io.github.cdklabs.projen.javascript

Class UpgradeDependencies.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.UpgradeDependencies.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UpgradeDependencies>

Enclosing class:

UpgradeDependencies

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

(experimental) A fluent builder for UpgradeDependencies.

Method Summary

Modifier and Type	Method and Description
UpgradeDependencies	build()
static UpgradeDependencies.Builder	create(NodeProject project)
UpgradeDependencies.Builder	exclude(List<String> exclude) (experimental) List of package names to exclude during the upgrade.
UpgradeDependencies.Builder	ignoreProjen(Boolean ignoreProjen) (experimental) Whether or not to ignore projen upgrades.
UpgradeDependencies.Builder	include(List<String> include) (experimental) List of package names to include during the upgrade.
UpgradeDependencies.Builder	pullRequestTitle(String pullRequestTitle) (experimental) Title of the pull request to use (should be all lower-case).
UpgradeDependencies.Builder	signoff(Boolean signoff) (experimental) Add Signed-off-by line by the committer at the end of the commit log message.
UpgradeDependencies.Builder	taskName(String taskName) (experimental) The name of the task that will be created.
UpgradeDependencies.Builder	workflow(Boolean workflow) (experimental) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.
UpgradeDependencies.Builder	workflowOptions(UpgradeDependenciesWorkflowOptions workflowOptions) (experimental) Options for the github workflow.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static UpgradeDependencies.Builder create(NodeProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of UpgradeDependencies.Builder.

exclude

@Stability(value=Experimental)
public UpgradeDependencies.Builder exclude(List<String> exclude)

(experimental) List of package names to exclude during the upgrade.

Default: - Nothing is excluded.

Parameters:

exclude - List of package names to exclude during the upgrade. This parameter is required.

Returns:

this

ignoreProjen

@Stability(value=Experimental)
public UpgradeDependencies.Builder ignoreProjen(Boolean ignoreProjen)

(experimental) Whether or not to ignore projen upgrades.

Default: true

Parameters:

ignoreProjen - Whether or not to ignore projen upgrades. This parameter is required.

Returns:

this

include

@Stability(value=Experimental)
public UpgradeDependencies.Builder include(List<String> include)

(experimental) List of package names to include during the upgrade.

Default: - Everything is included.

Parameters:

include - List of package names to include during the upgrade. This parameter is required.

Returns:

this

pullRequestTitle

@Stability(value=Experimental)
public UpgradeDependencies.Builder pullRequestTitle(String pullRequestTitle)

(experimental) Title of the pull request to use (should be all lower-case).

Default: "upgrade dependencies"

Parameters:

pullRequestTitle - Title of the pull request to use (should be all lower-case). This parameter is required.

Returns:

this

signoff

@Stability(value=Experimental)
public UpgradeDependencies.Builder signoff(Boolean signoff)

(experimental) Add Signed-off-by line by the committer at the end of the commit log message.

Default: true

Parameters:

signoff - Add Signed-off-by line by the committer at the end of the commit log message. This parameter is required.

Returns:

this

taskName

@Stability(value=Experimental)
public UpgradeDependencies.Builder taskName(String taskName)

(experimental) The name of the task that will be created.

This will also be the workflow name.

Default: "upgrade".

Parameters:

taskName - The name of the task that will be created. This parameter is required.

Returns:

this

workflow

@Stability(value=Experimental)
public UpgradeDependencies.Builder workflow(Boolean workflow)

(experimental) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.

If this is false, only a local projen task is created, which can be executed manually to upgrade the dependencies.

Default: - true for root projects, false for sub-projects.

Parameters:

workflow - Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule. This parameter is required.

Returns:

this

workflowOptions

@Stability(value=Experimental)
public UpgradeDependencies.Builder workflowOptions(UpgradeDependenciesWorkflowOptions workflowOptions)

(experimental) Options for the github workflow.

Only applies if workflow is true.

Default: - default options.

Parameters:

workflowOptions - Options for the github workflow. This parameter is required.

Returns:

this

build

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

Specified by:

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