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.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.892Z")
 @Stability(value=Experimental)
public interface UpgradeDependenciesOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `UpgradeDependencies`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UpgradeDependenciesOptions.Builder	builder()
default List<String>	getExclude() (experimental) List of package names to exclude during the upgrade.
default Boolean	getIgnoreProjen() (experimental) Whether or not to ignore projen upgrades.
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	getSignoff() (experimental) Add Signed-off-by line by the committer at the end of the commit log message.
default String	getTaskName() (experimental) The name of the task that will be created.
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(value=Experimental)
 @Nullable
default List<String> getExclude()

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

Default: - Nothing is excluded.

getIgnoreProjen

@Stability(value=Experimental)
 @Nullable
default Boolean getIgnoreProjen()

(experimental) Whether or not to ignore projen upgrades.

Default: true

getInclude

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

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

Default: - Everything is included.

getPullRequestTitle

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

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

Default: "upgrade dependencies"

getSignoff

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

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

Default: true

getTaskName

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

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

This will also be the workflow name.

Default: "upgrade".

getWorkflow

@Stability(value=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 sub-projects.

getWorkflowOptions

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

(experimental) Options for the github workflow.

Only applies if workflow is true.

Default: - default options.

builder

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

Returns:

a UpgradeDependenciesOptions.Builder of UpgradeDependenciesOptions