Package io.github.cdklabs.projen.github

Interface PullRequestBackportOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PullRequestBackportOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:12.011Z")
@Stability(Experimental)
public interface PullRequestBackportOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PullRequestBackportOptions.Builder	builder()
default Boolean	getAutoApproveBackport()	(experimental) Automatically approve backport PRs if the 'auto approve' workflow is available.
default String	getBackportBranchNamePrefix()	(experimental) The prefix used to name backport branches.
default List<String>	getBackportPRLabels()	(experimental) The labels added to the created backport PR.
default List<String>	getBranches()	(experimental) List of branches that can be a target for backports.
default Boolean	getCreateWithConflicts()	(experimental) Should this created Backport PRs with conflicts.
default String	getLabelPrefix()	(experimental) The prefix used to detect PRs that should be backported.
default String	getWorkflowName()	(experimental) The name of the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoApproveBackport

@Stability(Experimental)
@Nullable
default Boolean getAutoApproveBackport()

(experimental) Automatically approve backport PRs if the 'auto approve' workflow is available.

Default: true

getBackportBranchNamePrefix

@Stability(Experimental)
@Nullable
default String getBackportBranchNamePrefix()

(experimental) The prefix used to name backport branches.

Make sure to include a separator at the end like / or _.

Default: "backport/"

getBackportPRLabels

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

(experimental) The labels added to the created backport PR.

Default: ["backport"]

getBranches

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

(experimental) List of branches that can be a target for backports.

Default: - allow backports to all release branches

getCreateWithConflicts

@Stability(Experimental)
@Nullable
default Boolean getCreateWithConflicts()

(experimental) Should this created Backport PRs with conflicts.

Conflicts will have to be resolved manually, but a PR is always created. Set to false to prevent the backport PR from being created if there are conflicts.

Default: true

getLabelPrefix

@Stability(Experimental)
@Nullable
default String getLabelPrefix()

(experimental) The prefix used to detect PRs that should be backported.

Default: "backport-to-"

getWorkflowName

@Stability(Experimental)
@Nullable
default String getWorkflowName()

(experimental) The name of the workflow.

Default: "backport"

builder

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

Returns:

a PullRequestBackportOptions.Builder of PullRequestBackportOptions