queue ๐Ÿ”—

The queue action moves the pull request into one of the merge queue defined in queue_rules. The queue action takes the following parameter:

Key Name

Value Type

Default

Value Description

name

string

The name of the merge queue where to move the pull request.

method

string

merge

Merge method to use. Possible values are merge, squash or rebase.

rebase_fallback

string

merge

If method is set to rebase, but the pull request cannot be rebased, the method defined in rebase_fallback will be used instead. Possible values are merge, squash, null.

merge_bot_account

string

Mergify can impersonate a GitHub user to merge pull request. If no merge_bot_account is set, Mergify will merge the pull request itself. The user account must have already been logged in Mergify dashboard once and have write or maintain permission.

priority

1 <= integer <= 10000 or low or medium or high

medium

This sets the priority of the pull request in the queued. The pull request with the highest priority is merged first. low, medium, high are aliases for 1000, 2000, 3000.

commit_message

string

default

Defines what commit message to use when merging using the squash or merge method. Possible values are:

  • default to use the default commit message provided by GitHub or defined in the pull request body (see Defining the Commit Message).

  • title+body means to use the title and body from the pull request itself as the commit message. The pull request number will be added to end of the title.