Package io.github.cdklabs.projen.javascript

Interface UpgradeDependenciesOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UpgradeDependenciesOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.215Z")
@Stability(Experimental)
public interface UpgradeDependenciesOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for UpgradeDependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UpgradeDependenciesOptions.Builder	A builder for UpgradeDependenciesOptions
static class	UpgradeDependenciesOptions.Jsii$Proxy	An implementation for UpgradeDependenciesOptions

Method Summary

Modifier and Type	Method	Description
static UpgradeDependenciesOptions.Builder	builder()
default List<String>	getExclude()	(experimental) List of package names to exclude during the upgrade.
default List<String>	getInclude()	(experimental) List of package names to include during the upgrade.
default String	getPullRequestTitle()	(experimental) Title of the pull request to use (should be all lower-case).
default Boolean	getSatisfyPeerDependencies()	(experimental) Check peer dependencies of installed packages and filter updates to compatible versions.
default String	getSemanticCommit()	(experimental) The semantic commit type.
default Boolean	getSignoff()	(experimental) Add Signed-off-by line by the committer at the end of the commit log message.
default String	getTarget()	(experimental) Determines the target version to upgrade dependencies to.
default String	getTaskName()	(experimental) The name of the task that will be created.
default List<DependencyType>	getTypes()	(experimental) Specify which dependency types the upgrade should operate on.
default Boolean	getWorkflow()	(experimental) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.
default UpgradeDependenciesWorkflowOptions	getWorkflowOptions()	(experimental) Options for the github workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getExclude

@Stability(Experimental)
@Nullable
default List<String> getExclude()

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

Default: - Nothing is excluded.

getInclude

@Stability(Experimental)
@Nullable
default List<String> getInclude()

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

Default: - Everything is included.

getPullRequestTitle

@Stability(Experimental)
@Nullable
default String getPullRequestTitle()

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

Default: "upgrade dependencies"

getSatisfyPeerDependencies

@Stability(Experimental)
@Nullable
default Boolean getSatisfyPeerDependencies()

(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

See Also:

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

getSemanticCommit

@Stability(Experimental)
@Nullable
default String getSemanticCommit()

(experimental) The semantic commit type.

Default: 'chore'

getSignoff

@Stability(Experimental)
@Nullable
default Boolean getSignoff()

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

Default: true

getTarget

@Stability(Experimental)
@Nullable
default String getTarget()

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

Default: "minor"

See Also:

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

getTaskName

@Stability(Experimental)
@Nullable
default String getTaskName()

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

This will also be the workflow name.

Default: "upgrade".

getTypes

@Stability(Experimental)
@Nullable
default List<DependencyType> getTypes()

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

Default: - All dependency types.

getWorkflow

@Stability(Experimental)
@Nullable
default Boolean getWorkflow()

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

getWorkflowOptions

@Stability(Experimental)
@Nullable
default UpgradeDependenciesWorkflowOptions getWorkflowOptions()

(experimental) Options for the github workflow.

Only applies if workflow is true.

Default: - default options.

builder

@Stability(Experimental)
static UpgradeDependenciesOptions.Builder builder()

Returns:

a UpgradeDependenciesOptions.Builder of UpgradeDependenciesOptions