View as Markdown

Queue

Put your pull request into the merge queue.

The queue action allows you to put a pull request into the merge queue. By placing pull requests in the queue, you can make sure they are up-to-date and control their processing based on their priority.

If you have enabled auto_merge in merge_protections_settings, matching pull requests are added automatically and you usually do not need this action. Use the action when you want explicit, rule-driven or conditional enqueueing beyond what queue_conditions express.

Parameters

Section titled Parameters
Key nameValue type
allow_inplace_checksboolean or nulldeprecated

Deprecated: allow_inplace_checks on the queue action has no effect.

allow_merging_configuration_changeboolean or nulldeprecated

Deprecated: this option is no longer effective and can be safely removed from the configuration.

commit_message_templatetemplate or nulldeprecated

Deprecated: moved to queue_rules[name].commit_message_template.

merge_bot_accounttemplate or nulldeprecated

Deprecated: moved to queue_rules[name].merge_bot_account.

merge_methodmerge, rebase, squash, fast-forward or merge-batch or nulldeprecated

Deprecated: moved to queue_rules[name].merge_method.

methodmerge, rebase, squash, fast-forward or merge-batch or nulldeprecated

Deprecated: renamed to merge_method and moved to queue_rules[name].

namestring or null

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

queue_branch_merge_methodfast-forward or nulldeprecated

Deprecated: renamed to merge_method and moved to queue_rules[name].

update_bot_accounttemplate or nulldeprecated

Deprecated: moved to queue_rules[name].update_bot_account.

update_methodrebase or merge or nulldeprecated

Deprecated: moved to queue_rules[name].update_method.

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.

Was this page helpful?

Edit this page on GitHub