Package io.github.cdklabs.projen.javascript

Class UpgradeDependenciesOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UpgradeDependenciesOptions>

Enclosing interface:

UpgradeDependenciesOptions

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

A builder for UpgradeDependenciesOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpgradeDependenciesOptions	build()	Builds the configured instance.
UpgradeDependenciesOptions.Builder	exclude(List<String> exclude)	Sets the value of UpgradeDependenciesOptions.getExclude()
UpgradeDependenciesOptions.Builder	include(List<String> include)	Sets the value of UpgradeDependenciesOptions.getInclude()
UpgradeDependenciesOptions.Builder	pullRequestTitle(String pullRequestTitle)	Sets the value of UpgradeDependenciesOptions.getPullRequestTitle()
UpgradeDependenciesOptions.Builder	satisfyPeerDependencies(Boolean satisfyPeerDependencies)	Sets the value of UpgradeDependenciesOptions.getSatisfyPeerDependencies()
UpgradeDependenciesOptions.Builder	semanticCommit(String semanticCommit)	Sets the value of UpgradeDependenciesOptions.getSemanticCommit()
UpgradeDependenciesOptions.Builder	signoff(Boolean signoff)	Sets the value of UpgradeDependenciesOptions.getSignoff()
UpgradeDependenciesOptions.Builder	target(String target)	Sets the value of UpgradeDependenciesOptions.getTarget()
UpgradeDependenciesOptions.Builder	taskName(String taskName)	Sets the value of UpgradeDependenciesOptions.getTaskName()
UpgradeDependenciesOptions.Builder	types(List<? extends DependencyType> types)	Sets the value of UpgradeDependenciesOptions.getTypes()
UpgradeDependenciesOptions.Builder	workflow(Boolean workflow)	Sets the value of UpgradeDependenciesOptions.getWorkflow()
UpgradeDependenciesOptions.Builder	workflowOptions(UpgradeDependenciesWorkflowOptions workflowOptions)	Sets the value of UpgradeDependenciesOptions.getWorkflowOptions()

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

exclude

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder exclude(List<String> exclude)

Sets the value of UpgradeDependenciesOptions.getExclude()

Parameters:

exclude - List of package names to exclude during the upgrade.

Returns:

this

include

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder include(List<String> include)

Sets the value of UpgradeDependenciesOptions.getInclude()

Parameters:

include - List of package names to include during the upgrade.

Returns:

this

pullRequestTitle

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder pullRequestTitle(String pullRequestTitle)

Sets the value of UpgradeDependenciesOptions.getPullRequestTitle()

Parameters:

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

Returns:

this

satisfyPeerDependencies

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder satisfyPeerDependencies(Boolean satisfyPeerDependencies)

Sets the value of UpgradeDependenciesOptions.getSatisfyPeerDependencies()

Parameters:

satisfyPeerDependencies - Check peer dependencies of installed packages and filter updates to compatible versions. By default, the upgrade workflow will adhere to version constraints from peer dependencies. Sometimes this is not desirable and can be disabled.

Returns:

this

semanticCommit

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder semanticCommit(String semanticCommit)

Sets the value of UpgradeDependenciesOptions.getSemanticCommit()

Parameters:

semanticCommit - The semantic commit type.

Returns:

this

signoff

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder signoff(Boolean signoff)

Sets the value of UpgradeDependenciesOptions.getSignoff()

Parameters:

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

Returns:

this

target

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder target(String target)

Sets the value of UpgradeDependenciesOptions.getTarget()

Parameters:

target - Determines the target version to upgrade dependencies to.

Returns:

this

taskName

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder taskName(String taskName)

Sets the value of UpgradeDependenciesOptions.getTaskName()

Parameters:

taskName - The name of the task that will be created. This will also be the workflow name.

Returns:

this

types

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder types(List<? extends DependencyType> types)

Sets the value of UpgradeDependenciesOptions.getTypes()

Parameters:

types - Specify which dependency types the upgrade should operate on.

Returns:

this

workflow

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder workflow(Boolean workflow)

Sets the value of UpgradeDependenciesOptions.getWorkflow()

Parameters:

workflow - 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.

Returns:

this

workflowOptions

@Stability(Experimental)
public UpgradeDependenciesOptions.Builder workflowOptions(UpgradeDependenciesWorkflowOptions workflowOptions)

Sets the value of UpgradeDependenciesOptions.getWorkflowOptions()

Parameters:

workflowOptions - Options for the github workflow. Only applies if workflow is true.

Returns:

this

build

@Stability(Experimental)
public UpgradeDependenciesOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UpgradeDependenciesOptions

Throws:

NullPointerException - if any required attribute was not provided