io.github.cdklabs.projen.javascript

Class UpgradeDependenciesWorkflowOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

UpgradeDependenciesWorkflowOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

UpgradeDependenciesWorkflowOptions

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

An implementation for UpgradeDependenciesWorkflowOptions

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

UpgradeDependenciesWorkflowOptions.Builder, UpgradeDependenciesWorkflowOptions.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
List<String>	getBranches() (experimental) List of branches to create PR's for.
ContainerOptions	getContainer() (experimental) Job container options.
GitIdentity	getGitIdentity() (experimental) The git identity to use for commits.
List<String>	getLabels() (experimental) Labels to apply on the PR.
Boolean	getRebuild() (experimental) Execute 'build' after the upgrade.
List<String>	getRunsOn() (experimental) Github Runner selection labels.
UpgradeDependenciesSchedule	getSchedule() (experimental) Schedule to run on.
String	getSecret() (experimental) Which secret to use when creating the PR.
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

Methods inherited from interface io.github.cdklabs.projen.javascript.UpgradeDependenciesWorkflowOptions

builder

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(UpgradeDependenciesWorkflowOptions.Builder builder)

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

Method Detail

getBranches

public final List<String> getBranches()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) List of branches to create PR's for.

Default: - All release branches configured for the project.

Specified by:

getBranches in interface UpgradeDependenciesWorkflowOptions

getContainer

public final ContainerOptions getContainer()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Job container options.

Default: - defaults

Specified by:

getContainer in interface UpgradeDependenciesWorkflowOptions

getGitIdentity

public final GitIdentity getGitIdentity()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) The git identity to use for commits.

Default: "github-actions

Specified by:

getGitIdentity in interface UpgradeDependenciesWorkflowOptions

getLabels

public final List<String> getLabels()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Labels to apply on the PR.

Default: - no labels.

Specified by:

getLabels in interface UpgradeDependenciesWorkflowOptions

getRebuild

public final Boolean getRebuild()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Execute 'build' after the upgrade.

When true, the workflow will run the project build task after the dependency upgrade. This means that the PR created will include any changes caused by the build command, (e.g project synth changes, test snapshots)

This is necessary when using the default github token.

Default: true

Specified by:

getRebuild in interface UpgradeDependenciesWorkflowOptions

See Also:

for more details.

getRunsOn

public final List<String> getRunsOn()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Specified by:

getRunsOn in interface UpgradeDependenciesWorkflowOptions

getSchedule

public final UpgradeDependenciesSchedule getSchedule()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Schedule to run on.

Default: UpgradeDependenciesSchedule.DAILY

Specified by:

getSchedule in interface UpgradeDependenciesWorkflowOptions

getSecret

public final String getSecret()

Description copied from interface: UpgradeDependenciesWorkflowOptions

(experimental) Which secret to use when creating the PR.

When using the default github token, PR's created by this workflow will not trigger any subsequent workflows (i.e the build workflow). This is why this workflow also runs 'build' by default, and manually updates the status check of the PR.

If you pass a token that has the workflow permissions, you can skip running build in this workflow by specifying rebuild: false.

Default: - default github token.

Specified by:

getSecret in interface UpgradeDependenciesWorkflowOptions

See Also:

https://github.com/peter-evans/create-pull-request/issues/48

$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