Package io.github.cdklabs.projen.github

Class PullRequestBackport.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestBackport.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestBackport>

Enclosing class:

PullRequestBackport

@Stability(Experimental)
public static final class PullRequestBackport.Builder
extends Object
implements software.amazon.jsii.Builder<PullRequestBackport>

(experimental) A fluent builder for PullRequestBackport.

Method Summary

Modifier and Type	Method	Description
PullRequestBackport.Builder	autoApproveBackport(Boolean autoApproveBackport)	(experimental) Automatically approve backport PRs if the 'auto approve' workflow is available.
PullRequestBackport.Builder	backportBranchNamePrefix(String backportBranchNamePrefix)	(experimental) The prefix used to name backport branches.
PullRequestBackport.Builder	backportPrLabels(List<String> backportPrLabels)	(experimental) The labels added to the created backport PR.
PullRequestBackport.Builder	branches(List<String> branches)	(experimental) List of branches that can be a target for backports.
PullRequestBackport	build()
static PullRequestBackport.Builder	create(software.constructs.IConstruct scope)
PullRequestBackport.Builder	createWithConflicts(Boolean createWithConflicts)	(experimental) Should this created Backport PRs with conflicts.
PullRequestBackport.Builder	labelPrefix(String labelPrefix)	(experimental) The prefix used to detect PRs that should be backported.
PullRequestBackport.Builder	workflowName(String workflowName)	(experimental) The name of the workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Experimental)
public static PullRequestBackport.Builder create(software.constructs.IConstruct scope)

Parameters:

scope - This parameter is required.

Returns:

a new instance of PullRequestBackport.Builder.

autoApproveBackport

@Stability(Experimental)
public PullRequestBackport.Builder autoApproveBackport(Boolean autoApproveBackport)

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

Default: true

Parameters:

autoApproveBackport - Automatically approve backport PRs if the 'auto approve' workflow is available. This parameter is required.

Returns:

this

backportBranchNamePrefix

@Stability(Experimental)
public PullRequestBackport.Builder backportBranchNamePrefix(String backportBranchNamePrefix)

(experimental) The prefix used to name backport branches.

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

Default: "backport/"

Parameters:

backportBranchNamePrefix - The prefix used to name backport branches. This parameter is required.

Returns:

this

backportPrLabels

@Stability(Experimental)
public PullRequestBackport.Builder backportPrLabels(List<String> backportPrLabels)

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

Default: ["backport"]

Parameters:

backportPrLabels - The labels added to the created backport PR. This parameter is required.

Returns:

this

branches

@Stability(Experimental)
public PullRequestBackport.Builder branches(List<String> branches)

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

Default: - allow backports to all release branches

Parameters:

branches - List of branches that can be a target for backports. This parameter is required.

Returns:

this

createWithConflicts

@Stability(Experimental)
public PullRequestBackport.Builder createWithConflicts(Boolean createWithConflicts)

(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

Parameters:

createWithConflicts - Should this created Backport PRs with conflicts. This parameter is required.

Returns:

this

labelPrefix

@Stability(Experimental)
public PullRequestBackport.Builder labelPrefix(String labelPrefix)

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

Default: "backport-to-"

Parameters:

labelPrefix - The prefix used to detect PRs that should be backported. This parameter is required.

Returns:

this

workflowName

@Stability(Experimental)
public PullRequestBackport.Builder workflowName(String workflowName)

(experimental) The name of the workflow.

Default: "backport"

Parameters:

workflowName - The name of the workflow. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public PullRequestBackport build()

Specified by:

build in interface software.amazon.jsii.Builder<PullRequestBackport>

Returns:

a newly built instance of PullRequestBackport.