Package 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(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	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	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	satisfyPeerDependencies(Boolean satisfyPeerDependencies)	(experimental) Check peer dependencies of installed packages and filter updates to compatible versions.
UpgradeDependencies.Builder	semanticCommit(String semanticCommit)	(experimental) The semantic commit type.
UpgradeDependencies.Builder	signoff(Boolean signoff)	(experimental) Add Signed-off-by line by the committer at the end of the commit log message.
UpgradeDependencies.Builder	target(String target)	(experimental) Determines the target version to upgrade dependencies to.
UpgradeDependencies.Builder	taskName(String taskName)	(experimental) The name of the task that will be created.
UpgradeDependencies.Builder	types(List<? extends DependencyType> types)	(experimental) Specify which dependency types the upgrade should operate on.
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(Experimental)
public static UpgradeDependencies.Builder create(NodeProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of UpgradeDependencies.Builder.

exclude

@Stability(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

include

@Stability(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(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

satisfyPeerDependencies

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

(experimental) 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.

Default: true

Parameters:

satisfyPeerDependencies - Check peer dependencies of installed packages and filter updates to compatible versions. This parameter is required.

Returns:

this

See Also:

https://github.com/raineorshine/npm-check-updates#peer

semanticCommit

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

(experimental) The semantic commit type.

Default: 'chore'

Parameters:

semanticCommit - The semantic commit type. This parameter is required.

Returns:

this

signoff

@Stability(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

target

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

(experimental) Determines the target version to upgrade dependencies to.

Default: "minor"

Parameters:

target - Determines the target version to upgrade dependencies to. This parameter is required.

Returns:

this

See Also:

https://github.com/raineorshine/npm-check-updates#target

taskName

@Stability(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

types

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

(experimental) Specify which dependency types the upgrade should operate on.

Default: - All dependency types.

Parameters:

types - Specify which dependency types the upgrade should operate on. This parameter is required.

Returns:

this

workflow

@Stability(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 subprojects.

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(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(Experimental)
public UpgradeDependencies build()

Specified by:

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

Returns:

a newly built instance of UpgradeDependencies.