@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
| Modifier and Type | Interface and Description |
|---|---|
static class |
UpgradeDependenciesWorkflowOptions.Builder
A builder for
UpgradeDependenciesWorkflowOptions |
static class |
UpgradeDependenciesWorkflowOptions.Jsii$Proxy
An implementation for
UpgradeDependenciesWorkflowOptions |
| 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.
|
@Stability(value=Experimental) @Nullable default List<String> getBranches()
Default: - All release branches configured for the project.
@Stability(value=Experimental) @Nullable default ContainerOptions getContainer()
Default: - defaults
@Stability(value=Experimental) @Nullable default GitIdentity getGitIdentity()
Default: "github-actions
@Stability(value=Experimental) @Nullable default List<String> getLabels()
Default: - no labels.
@Stability(value=Experimental) @Nullable default Boolean getRebuild()
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
for more details.@Stability(value=Experimental) @Nullable default List<String> getRunsOn()
Default: ["ubuntu-latest"]
@Stability(value=Experimental) @Nullable default UpgradeDependenciesSchedule getSchedule()
Default: UpgradeDependenciesSchedule.DAILY
@Stability(value=Experimental) @Nullable default String getSecret()
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.
https://github.com/peter-evans/create-pull-request/issues/48@Stability(value=Experimental) static UpgradeDependenciesWorkflowOptions.Builder builder()
Copyright © 2021. All rights reserved.