Package io.github.cdklabs.projen.github

Class AutoMerge.Builder

java.lang.Object

io.github.cdklabs.projen.github.AutoMerge.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AutoMerge>

Enclosing class:

AutoMerge

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

(experimental) A fluent builder for AutoMerge.

Method Summary

Modifier and Type	Method	Description
AutoMerge.Builder	approvedReviews(Number approvedReviews)	(experimental) Number of approved code reviews.
AutoMerge.Builder	blockingLabels(List<String> blockingLabels)	(experimental) List of labels that will prevent auto-merging.
AutoMerge	build()
static AutoMerge.Builder	create(GitHub github)
AutoMerge.Builder	queueName(String queueName)	(experimental) Name of the mergify queue.
AutoMerge.Builder	ruleName(String ruleName)	(experimental) Name of the mergify rule.

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 AutoMerge.Builder create(GitHub github)

Parameters:

github - This parameter is required.

Returns:

a new instance of AutoMerge.Builder.

approvedReviews

@Stability(Experimental)
public AutoMerge.Builder approvedReviews(Number approvedReviews)

(experimental) Number of approved code reviews.

Default: 1

Parameters:

approvedReviews - Number of approved code reviews. This parameter is required.

Returns:

this

blockingLabels

@Stability(Experimental)
public AutoMerge.Builder blockingLabels(List<String> blockingLabels)

(experimental) List of labels that will prevent auto-merging.

Default: ['do-not-merge']

Parameters:

blockingLabels - List of labels that will prevent auto-merging. This parameter is required.

Returns:

this

queueName

@Stability(Experimental)
public AutoMerge.Builder queueName(String queueName)

(experimental) Name of the mergify queue.

Default: 'default'

Parameters:

queueName - Name of the mergify queue. This parameter is required.

Returns:

this

ruleName

@Stability(Experimental)
public AutoMerge.Builder ruleName(String ruleName)

(experimental) Name of the mergify rule.

Default: 'Automatic merge on approval and successful build'

Parameters:

ruleName - Name of the mergify rule. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public AutoMerge build()

Specified by:

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

Returns:

a newly built instance of AutoMerge.