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.

The action needs the Merge Queue to be enabled on the repository. Without it, the action reports an error and the pull request is not queued.

If you have enabled auto_merge_conditions 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.

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.