A merge queue check module defines a Java component that enforces a specific merge pre-condition on pull requests in a merge queue. For example a merge queue check could be used to verify a successful build of the prepared merge commit in an external CI system.

Merge queue checks return a result state:

Reject, which immediately causes the pull request to be removed from the queue and feedback given to the user
Accept, which allows the pull request to merge when all other checks have accepted (and the pull request is at the front of the queue)
Pending, which allows the pull request to remain in the queue for future re-evaluation of the check result

See the how-to guide for more information on creating a merge queue check.

Configuration

The root element for the Merge Queue Check plugin module is <merge-queue-check/>. It allows the following configuration attributes:

Attributes

Name	Required	Description	Default
key	Yes	The identifier of the plugin module. This key must be unique within the plugin where it is defined.	N/A
class	Yes	The fully qualified Java class name of the class that implements the Merge Queue Check SPI. This class must implement `MergeQueueCheck`.	N/A

Example

Here is an example atlassian-plugin.xml file containing a merge queue check module registration.

1
2
<atlassian-plugin 
        key="${project.groupId}.${project.artifactId}" 
        name="${project.name}" 
        plugins-version="2">

    <plugin-info>
        <description>${project.description}</description>
        <version>${project.version}</version>
        <vendor name="${project.organization.name}" 
                url="${project.organization.url}" />
    </plugin-info>
    
    <merge-queue-check 
            key="example-merge-queue-check" 
            class="com.example.mergequeue.ExampleMergeQueueCheck"/>

</atlassian-plugin>