Package 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.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.216Z")
@Stability(Experimental)
public interface UpgradeDependenciesWorkflowOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for UpgradeDependencies.workflowOptions.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UpgradeDependenciesWorkflowOptions.Builder	builder()
default List<String>	getAssignees()	(experimental) Assignees to add on the PR.
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 JobPermissions	getPermissions()	(experimental) Permissions granted to the upgrade job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.
default GithubCredentials	getProjenCredentials()	(experimental) Choose a method for authenticating with GitHub for creating the PR.
default List<String>	getRunsOn()	(experimental) Github Runner selection labels.
default GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.
default UpgradeDependenciesSchedule	getSchedule()	(experimental) Schedule to run on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAssignees

@Stability(Experimental)
@Nullable
default List<String> getAssignees()

(experimental) Assignees to add on the PR.

Default: - no assignees

getBranches

@Stability(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(Experimental)
@Nullable
default ContainerOptions getContainer()

(experimental) Job container options.

Default: - defaults

getGitIdentity

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

(experimental) The git identity to use for commits.

Default: "github-actions@github.com"

getLabels

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

(experimental) Labels to apply on the PR.

Default: - no labels.

getPermissions

@Stability(Experimental)
@Nullable
default JobPermissions getPermissions()

(experimental) Permissions granted to the upgrade job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

Default: `{ contents: JobPermission.READ }`

getProjenCredentials

@Stability(Experimental)
@Nullable
default GithubCredentials getProjenCredentials()

(experimental) Choose a method for authenticating with GitHub for 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), so projen requires API access to be provided through e.g. a personal access token or other method.

Default: - personal access token named PROJEN_GITHUB_TOKEN

See Also:

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

getRunsOn

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

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

getRunsOnGroup

@Stability(Experimental)
@Nullable
default GroupRunnerOptions getRunsOnGroup()

(experimental) Github Runner Group selection options.

getSchedule

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

(experimental) Schedule to run on.

Default: UpgradeDependenciesSchedule.DAILY

builder

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

Returns:

a UpgradeDependenciesWorkflowOptions.Builder of UpgradeDependenciesWorkflowOptions