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.

Parameters

Section titled Parameters
Key nameValue typeDefault
allow_merging_configuration_changeboolean
true
deprecated

Allow merging the Mergify configuration file. This option does not do anything and is only present for backward compatibility.

autosquashboolean
true
deprecated

This option is relevant only if you do in place checks and if you use the rebase option of the update_method. It will automatically squash your commits beginning by squash!, fixup! or amend!, just like the option with the same name when doing a git rebase.

commit_message_templatetemplate or null
null
deprecated

Template to use as the commit message when using the merge or squash merge method.

merge_bot_accounttemplate or null
null
deprecated

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

merge_methodmerge, rebase, squash or fast-forward or null
null
deprecated

Merge method to use. If no value is set, Mergify uses the first authorized method available in the repository configuration. fast-forward is not supported on queues with max_parallel_checks > 1, batch_size > 1, or with allow_inplace_checksset tofalse`.

namestring or null
null

The name of the queue where the pull request should be added. If no name is set, queue_conditions will be applied instead.

update_bot_accounttemplate or null
null
deprecated

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 update_bot_account is set, Mergify picks randomly one of the organization users instead. The user account must have already been logged in Mergify dashboard once. This option overrides the value defined in the queue rules section of the configuration.

update_methodrebase or merge or null
null
deprecated

Method to use to update the pull request with its base branch when the check is done in place. Possible values:

  • merge to merge the base branch into the pull request.
  • rebase to rebase the pull request against its base branch.

This option overrides the value defined in the queue rules section of the configuration. The default is rebase when the merge_method is fast-forward.

Examples

Section titled Examples
pull_request_rules:
  - name: put PRs in queue
    conditions:
      - label = queue-me
    actions:
      queue:

In this example, any pull request that has the label queue-me will be automatically queued. The pull request still needs to match the queue_conditions defined in the queue to enter the queue.