Package io.github.cdklabs.projen.github

Interface MergifyQueue

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MergifyQueue.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MergifyQueue.Builder	builder()
List<Object>	getConditions()	(experimental) A list of Conditions string that must match against the pull request for the pull request to be added to the queue.
default String	getMergeMethod()	(experimental) Merge method to use.
String	getName()	(experimental) The name of the queue.
default String	getUpdateMethod()	(experimental) Method to use to update the pull request with its base branch when the speculative check is done in-place.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConditions

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

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

See Also:

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

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The name of the queue.

getMergeMethod

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

(experimental) 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.

Default: "merge"

getUpdateMethod

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

(experimental) 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.

Default: - `merge` for all merge methods except `fast-forward` where `rebase` is used

See Also:

https://docs.mergify.com/actions/queue/#queue-rules

builder

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

Returns:

a MergifyQueue.Builder of MergifyQueue