Pull Request Lifecycle

MergeQueue tracks your pull request from the time it is opened until it is merged (or closed without merging). There are several different states a pull request can be in at any given time.

Open

A pull request is open when it has not been marked as ready-to-merge and is not closed on GitHub.

Pull requests can be marked as ready-to-merge by adding the label configured in merge_rules.labels in the YAML configuration, adding a slash command comment to the pull request, or using the Aviator API.

Pending

A pull request is pending when it has been marked as ready-to-merge but is not yet ready to enter the queue for some reason.

MergeQueue will validate all the necessary pre-conditions (such as passing all required checks, having no merge conflicts, and having sufficient approvals) before the pull request enters the queue.

Generally, a pull request is pending if it will enter the queue without any action from the pull request author (for example, the pull request is still running some required tests when the check_mergeability_to_queue setting is enabled).

When a pull request is pending, Aviator will report the reason why it has not yet entered the queue on the pull request sticky comment.

Queued

A pull request is queued when it has been marked as ready-to-merge and has passed all the necessary queue pre-conditions.

Once queued, MergeQueue will validate the changes in the pull request against the latest changes in the target branch (depending on the repository's queue mode) and merge the pull request if it passes all the required checks.

Blocked

A pull request is blocked if it cannot not be merged and requires action from the pull request author (such as resolving merge conflicts or fixing broken tests).

Possible reasons for a pull request to be blocked include:

• There was a merge conflict with the target branch or another pull request in the queue.

• One or more of the required checks failed.

• Approvals were removed from the pull request after it entered the queue.

• The HEAD commit of the pull request was modified after it was marked as ready-to-merge.

See the pull request status code documentation for more details about the possible reasons a pull request can become blocked.

Merged

A pull request is merged once its changes have been successfully merged into the pull request's target branch (either by MergeQueue or manually using the GitHub merge functionality).

Pull requests can sometimes be merged (from MergeQueue's perspective) even if the GitHub pull request is not literally merged (for example, if the repository is using fast-forwarding).

Closed

A pull request is closed if it has been closed without merging its changes.