Queue
Put your pull request into the merge queue.
The queue
action allows you to put a pull request into a merge
queue. By placing pull requests in a queue, you can make sure
they are up-to-date and control their processing based on their priority.
Each queue can also have its own configuration for speculative checks, batches, etc.
Parameters
Section titled ParametersKey name | Value type | Default | |
---|---|---|---|
autosquash | boolean | true
| |
This option is relevant only if you do inplace checks and if you use the | |||
commit_message_template | template | ||
Template to use as the commit message when using the | |||
merge_bot_account | template | ||
Mergify can impersonate a GitHub user to merge pull requests. If no | |||
merge_method | merge method: | ||
Merge method to use. If no value is set, Mergify will use the first authorized method available in the repository configuration. | |||
name | string | ||
The name of the queue where the pull request should be added. If no name is set, | |||
priority | priority: | medium
| deprecated |
To set your priorities, you should now use | |||
require_branch_protection | boolean | true
| deprecated |
Whether branch protections are required for queueing pull requests. | |||
update_bot_account | template | ||
For certain actions, such as rebasing branches, Mergify has to impersonate a GitHub user. You can specify the account to use with this option. If no This option overrides the value defined in the queue rules section of the configuration. | |||
update_method | merge or rebase | merge
| |
Method to use to update the pull request with its base branch when the speculative check is done in-place. Possible values:
|
Examples
Section titled ExamplesSimple Queue
Section titled Simple QueueIn this example, any pull request that is based on the main branch will be
placed in the production queue. The pull request still needs to match the
queue_conditions
defined in the queue to enter the queue.
Choosing the Merge Method
Section titled Choosing the Merge MethodIn this example, any pull request that has the label rebase
will enter the
queue with a merge_method
set to rebase
, ensuring it’s merged via rebase.
Whereas all the other pull requests will be merged using the merge
method.