Package io.github.cdklabs.projen.github

Interface AutoMergeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoMergeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.064Z")
@Stability(Experimental)
public interface AutoMergeOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AutoMergeOptions.Builder	A builder for AutoMergeOptions
static class	AutoMergeOptions.Jsii$Proxy	An implementation for AutoMergeOptions

Method Summary

Modifier and Type	Method	Description
static AutoMergeOptions.Builder	builder()
default Number	getApprovedReviews()	(experimental) Number of approved code reviews.
default List<String>	getBlockingLabels()	(experimental) List of labels that will prevent auto-merging.
default String	getQueueName()	(experimental) Name of the mergify queue.
default String	getRuleName()	(experimental) Name of the mergify rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApprovedReviews

@Stability(Experimental)
@Nullable
default Number getApprovedReviews()

(experimental) Number of approved code reviews.

Default: 1

getBlockingLabels

@Stability(Experimental)
@Nullable
default List<String> getBlockingLabels()

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

Default: ['do-not-merge']

getQueueName

@Stability(Experimental)
@Nullable
default String getQueueName()

(experimental) Name of the mergify queue.

Default: 'default'

getRuleName

@Stability(Experimental)
@Nullable
default String getRuleName()

(experimental) Name of the mergify rule.

Default: 'Automatic merge on approval and successful build'

builder

@Stability(Experimental)
static AutoMergeOptions.Builder builder()

Returns:

a AutoMergeOptions.Builder of AutoMergeOptions