Package io.github.cdklabs.projen.github

Interface MergifyRule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MergifyRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-28T17:20:29.240Z")
@Stability(Experimental)
public interface MergifyRule
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MergifyRule.Builder	builder()
Map<String,Object>	getActions()	(experimental) A dictionary made of Actions that will be executed on the matching pull requests.
List<Object>	getConditions()	(experimental) A list of Conditions string that must match against the pull request for the rule to be applied.
String	getName()	(experimental) The name of the rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActions

@Stability(Experimental)
@NotNull
Map<String,Object> getActions()

(experimental) A dictionary made of Actions that will be executed on the matching pull requests.

See Also:

https://docs.mergify.io/actions/#actions

getConditions

@Stability(Experimental)
@NotNull
List<Object> getConditions()

(experimental) A list of Conditions string that must match against the pull request for the rule to be applied.

See Also:

https://docs.mergify.io/conditions/#conditions

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of the rule.

This is not used by the engine directly, but is used when reporting information about a rule.

builder

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

Returns:

a MergifyRule.Builder of MergifyRule