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 forPullRequestBackportOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
autoApproveBackport
@Stability(Experimental) public PullRequestBackportOptions.Builder autoApproveBackport(Boolean autoApproveBackport)
Sets the value ofPullRequestBackportOptions.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 ofPullRequestBackportOptions.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 ofPullRequestBackportOptions#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 ofPullRequestBackportOptions.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 ofPullRequestBackportOptions.getCreateWithConflicts()- Parameters:
createWithConflicts- Should this created Backport PRs with conflicts. Conflicts will have to be resolved manually, but a PR is always created. Set tofalseto 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 ofPullRequestBackportOptions.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 ofPullRequestBackportOptions.getWorkflowName()- Parameters:
workflowName- The name of the workflow.- Returns:
this
-
build
@Stability(Experimental) public PullRequestBackportOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<PullRequestBackportOptions>- Returns:
- a new instance of
PullRequestBackportOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-