Package io.github.cdklabs.projen.github

Class MergifyQueue.Builder

java.lang.Object

io.github.cdklabs.projen.github.MergifyQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MergifyQueue>

Enclosing interface:

MergifyQueue

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

A builder for MergifyQueue

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MergifyQueue	build()	Builds the configured instance.
MergifyQueue.Builder	conditions(List<? extends Object> conditions)	Sets the value of MergifyQueue.getConditions()
MergifyQueue.Builder	mergeMethod(String mergeMethod)	Sets the value of MergifyQueue.getMergeMethod()
MergifyQueue.Builder	name(String name)	Sets the value of MergifyQueue.getName()
MergifyQueue.Builder	updateMethod(String updateMethod)	Sets the value of MergifyQueue.getUpdateMethod()

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

conditions

@Stability(Experimental)
public MergifyQueue.Builder conditions(List<? extends Object> conditions)

Sets the value of MergifyQueue.getConditions()

Parameters:

conditions - A list of Conditions string that must match against the pull request for the pull request to be added to the queue. This parameter is required.

Returns:

this

name

@Stability(Experimental)
public MergifyQueue.Builder name(String name)

Sets the value of MergifyQueue.getName()

Parameters:

name - The name of the queue. This parameter is required.

Returns:

this

mergeMethod

@Stability(Experimental)
public MergifyQueue.Builder mergeMethod(String mergeMethod)

Sets the value of MergifyQueue.getMergeMethod()

Parameters:

mergeMethod - Merge method to use. Possible values are merge, squash, rebase or fast-forward. fast-forward is not supported on queues with speculative_checks > 1, batch_size > 1, or with allow_inplace_checks set to false.

Returns:

this

updateMethod

@Stability(Experimental)
public MergifyQueue.Builder updateMethod(String updateMethod)

Sets the value of MergifyQueue.getUpdateMethod()

Parameters:

updateMethod - Method to use to update the pull request with its base branch when the speculative check is done in-place. Possible values:

• merge to merge the base branch into the pull request.
• rebase to rebase the pull request against its base branch.

Note that the rebase method has some drawbacks, see Mergify docs for details.

Returns:

this

build

@Stability(Experimental)
public MergifyQueue build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MergifyQueue

Throws:

NullPointerException - if any required attribute was not provided