io.github.cdklabs.projen.javascript

Interface UpgradeDependenciesWorkflowOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UpgradeDependenciesWorkflowOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.893Z")
 @Stability(value=Experimental)
public interface UpgradeDependenciesWorkflowOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `UpgradeDependencies.workflowOptions`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UpgradeDependenciesWorkflowOptions.Builder	builder()
default List<String>	getBranches() (experimental) List of branches to create PR's for.
default ContainerOptions	getContainer() (experimental) Job container options.
default GitIdentity	getGitIdentity() (experimental) The git identity to use for commits.
default List<String>	getLabels() (experimental) Labels to apply on the PR.
default Boolean	getRebuild() (experimental) Execute 'build' after the upgrade.
default List<String>	getRunsOn() (experimental) Github Runner selection labels.
default UpgradeDependenciesSchedule	getSchedule() (experimental) Schedule to run on.
default String	getSecret() (experimental) Which secret to use when creating the PR.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBranches

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

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

Default: - All release branches configured for the project.

getContainer

@Stability(value=Experimental)
 @Nullable
default ContainerOptions getContainer()

(experimental) Job container options.

Default: - defaults

getGitIdentity

@Stability(value=Experimental)
 @Nullable
default GitIdentity getGitIdentity()

(experimental) The git identity to use for commits.

Default: "github-actions

getLabels

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

(experimental) Labels to apply on the PR.

Default: - no labels.

getRebuild

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

(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

See Also:

for more details.

getRunsOn

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

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

getSchedule

@Stability(value=Experimental)
 @Nullable
default UpgradeDependenciesSchedule getSchedule()

(experimental) Schedule to run on.

Default: UpgradeDependenciesSchedule.DAILY

getSecret

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

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

See Also:

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

builder

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

Returns:

a UpgradeDependenciesWorkflowOptions.Builder of UpgradeDependenciesWorkflowOptions