Mergify Dequeue Command

The dequeue command removes a pull request from the merge queue. This command is ideal for situations where you realize a pull request either shouldn’t be merged or needs further revision before merging.

@Mergifyio dequeue

A queue command leaves a pull request in one of two states, and dequeue covers both:

• In the queue. Mergify takes the pull request out and reports that it has been removed from the queue.

• Waiting to enter it. A queue command stays pending until the pull request matches a queue’s queue_conditions. dequeue cancels that pending command, so the pull request is not queued later when the conditions eventually match.

When neither applies, Mergify answers that the pull request is not queued and does nothing else.

A dequeued pull request never rejoins the queue on its own. Run @mergifyio queue again once it’s ready, as described in Requeuing a pull request in the merge queue.

Dequeuing a pull request that others are stacked on top of also removes the ones above it that are still in the queue. See cascade dequeue.

The Mergify API dequeues a pull request without a comment:

curl -X POST \
     -H "Authorization: Bearer <token>" \
     https://api.mergify.com/v1/repos/<owner>/<repository>/merge-queue/pull/<number>/dequeue

It covers the same two states as the command: it takes the pull request out of the queue, or cancels a queue request still waiting for queue_conditions, including one made through the API. Mergify answers 204 No Content.

The call needs the same credentials as queueing, and the command restrictions set for dequeue apply to it. When Mergify refuses the request, the response body carries an error_code:

The request is recorded as a command.dequeue event, with the fields described in the event log.