Package io.github.cdklabs.projen.javascript

Class UpgradeDependenciesOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions.Jsii$Proxy

All Implemented Interfaces:

UpgradeDependenciesOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

UpgradeDependenciesOptions

@Stability(Experimental)
@Internal
public static final class UpgradeDependenciesOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements UpgradeDependenciesOptions

An implementation for UpgradeDependenciesOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions

UpgradeDependenciesOptions.Builder, UpgradeDependenciesOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(UpgradeDependenciesOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the UpgradeDependenciesOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(UpgradeDependenciesOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the UpgradeDependenciesOptions.Builder.

Method Detail

getExclude

public final List<String> getExclude()

Description copied from interface: UpgradeDependenciesOptions

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

Default: - Nothing is excluded.

Specified by:

getExclude in interface UpgradeDependenciesOptions

getInclude

public final List<String> getInclude()

Description copied from interface: UpgradeDependenciesOptions

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

Default: - Everything is included.

Specified by:

getInclude in interface UpgradeDependenciesOptions

getPullRequestTitle

public final String getPullRequestTitle()

Description copied from interface: UpgradeDependenciesOptions

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

Default: "upgrade dependencies"

Specified by:

getPullRequestTitle in interface UpgradeDependenciesOptions

getSatisfyPeerDependencies

public final Boolean getSatisfyPeerDependencies()

Description copied from interface: UpgradeDependenciesOptions

(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

Specified by:

getSatisfyPeerDependencies in interface UpgradeDependenciesOptions

See Also:

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

getSemanticCommit

public final String getSemanticCommit()

Description copied from interface: UpgradeDependenciesOptions

(experimental) The semantic commit type.

Default: 'chore'

Specified by:

getSemanticCommit in interface UpgradeDependenciesOptions

getSignoff

public final Boolean getSignoff()

Description copied from interface: UpgradeDependenciesOptions

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

Default: true

Specified by:

getSignoff in interface UpgradeDependenciesOptions

getTarget

public final String getTarget()

Description copied from interface: UpgradeDependenciesOptions

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

Default: "minor"

Specified by:

getTarget in interface UpgradeDependenciesOptions

See Also:

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

getTaskName

public final String getTaskName()

Description copied from interface: UpgradeDependenciesOptions

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

This will also be the workflow name.

Default: "upgrade".

Specified by:

getTaskName in interface UpgradeDependenciesOptions

getTypes

public final List<DependencyType> getTypes()

Description copied from interface: UpgradeDependenciesOptions

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

Default: - All dependency types.

Specified by:

getTypes in interface UpgradeDependenciesOptions

getWorkflow

public final Boolean getWorkflow()

Description copied from interface: UpgradeDependenciesOptions

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

Specified by:

getWorkflow in interface UpgradeDependenciesOptions

getWorkflowOptions

public final UpgradeDependenciesWorkflowOptions getWorkflowOptions()

Description copied from interface: UpgradeDependenciesOptions

(experimental) Options for the github workflow.

Only applies if workflow is true.

Default: - default options.

Specified by:

getWorkflowOptions in interface UpgradeDependenciesOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object