Package io.github.cdklabs.projen.github

Class AutoMerge

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.github.AutoMerge

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.064Z")
@Stability(Experimental)
public class AutoMerge
extends Component

(experimental) Sets up mergify to merging approved pull requests.

If buildJob is specified, the specified GitHub workflow job ID is required to succeed in order for the PR to be merged.

approvedReviews specified the number of code review approvals required for the PR to be merged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoMerge.Builder	(experimental) A fluent builder for AutoMerge.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	AutoMerge(GitHub github)
	AutoMerge(GitHub github, AutoMergeOptions options)
protected	AutoMerge(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AutoMerge(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addConditions(@NotNull String... conditions)	(experimental) Adds conditions to the auto merge rule.
void	addConditionsLater(IAddConditionsLater later)	(experimental) Adds conditions that will be rendered only during synthesis.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AutoMerge

protected AutoMerge(software.amazon.jsii.JsiiObjectRef objRef)

AutoMerge

protected AutoMerge(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AutoMerge

@Stability(Experimental)
public AutoMerge(@NotNull
                 GitHub github,
                 @Nullable
                 AutoMergeOptions options)

Parameters:

github - This parameter is required.

options -

AutoMerge

@Stability(Experimental)
public AutoMerge(@NotNull
                 GitHub github)

Parameters:

github - This parameter is required.

Method Detail

addConditions

@Stability(Experimental)
public void addConditions(@NotNull
                          @NotNull String... conditions)

(experimental) Adds conditions to the auto merge rule.

Parameters:

conditions - The conditions to add (mergify syntax). This parameter is required.

addConditionsLater

@Stability(Experimental)
public void addConditionsLater(@NotNull
                               IAddConditionsLater later)

(experimental) Adds conditions that will be rendered only during synthesis.

Parameters:

later - The later. This parameter is required.