Package io.github.cdklabs.projen.github

Class PullRequestBackportOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestBackportOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestBackportOptions>

Enclosing interface:

PullRequestBackportOptions

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

A builder for PullRequestBackportOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PullRequestBackportOptions.Builder	autoApproveBackport(Boolean autoApproveBackport)	Sets the value of PullRequestBackportOptions.getAutoApproveBackport()
PullRequestBackportOptions.Builder	backportBranchNamePrefix(String backportBranchNamePrefix)	Sets the value of PullRequestBackportOptions.getBackportBranchNamePrefix()
PullRequestBackportOptions.Builder	backportPrLabels(List<String> backportPrLabels)	Sets the value of PullRequestBackportOptions#getBackportPrLabels
PullRequestBackportOptions.Builder	branches(List<String> branches)	Sets the value of PullRequestBackportOptions.getBranches()
PullRequestBackportOptions	build()	Builds the configured instance.
PullRequestBackportOptions.Builder	createWithConflicts(Boolean createWithConflicts)	Sets the value of PullRequestBackportOptions.getCreateWithConflicts()
PullRequestBackportOptions.Builder	labelPrefix(String labelPrefix)	Sets the value of PullRequestBackportOptions.getLabelPrefix()
PullRequestBackportOptions.Builder	workflowName(String workflowName)	Sets the value of PullRequestBackportOptions.getWorkflowName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

autoApproveBackport

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

Sets the value of PullRequestBackportOptions.getAutoApproveBackport()

Parameters:

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

Returns:

this

backportBranchNamePrefix

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

Sets the value of PullRequestBackportOptions.getBackportBranchNamePrefix()

Parameters:

backportBranchNamePrefix - The prefix used to name backport branches. Make sure to include a separator at the end like / or _.

Returns:

this

backportPrLabels

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

Sets the value of PullRequestBackportOptions#getBackportPrLabels

Parameters:

backportPrLabels - The labels added to the created backport PR.

Returns:

this

branches

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

Sets the value of PullRequestBackportOptions.getBranches()

Parameters:

branches - List of branches that can be a target for backports.

Returns:

this

createWithConflicts

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

Sets the value of PullRequestBackportOptions.getCreateWithConflicts()

Parameters:

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

Returns:

this

labelPrefix

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

Sets the value of PullRequestBackportOptions.getLabelPrefix()

Parameters:

labelPrefix - The prefix used to detect PRs that should be backported.

Returns:

this

workflowName

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

Sets the value of PullRequestBackportOptions.getWorkflowName()

Parameters:

workflowName - The name of the workflow.

Returns:

this

build

@Stability(Experimental)
public PullRequestBackportOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PullRequestBackportOptions

Throws:

NullPointerException - if any required attribute was not provided