Submit, cancel and restart a pull request

A pull request enters the queue of its base branch. You do not create a queue: the first submission on the default branch of the repository, or on a branch that .cihub.yaml serves, creates it.

Who can run a commandCopy Anchor Link

A command needs the write permission on the repository. The queue answers each command on the pull request:

• a 👍 reaction on the comment when it accepts the command;
• a comment that quotes the command and gives the cause when it refuses it: @octocat, the queue refused this command: <cause>.

The queue accepts a submission only for an open pull request that is not a draft.

Submit a pull requestCopy Anchor Link

Any of these submits the pull request, with the same effect:

A submitted pull request first waits until it meets the rules of its branch and the queue_conditions of the queue (The life of a pull request in the queue): you can submit it before its review or its checks end.

Give a pull request a priorityCopy Anchor Link

/cihub merge --priority=urgent
/cihub merge --priority=high --no-batch
/cihub merge --profile=dependencies

Without --priority, the first rule of priority_rules in .cihub.yaml that the pull request meets gives its priority. The command line takes the same options: cihub queue merge 123 -p urgent --no-batch.

Cancel a submissionCopy Anchor Link

/cihub cancel

Or cihub queue cancel 123, the dashboard, or the removal of the submission label. The pull request leaves the queue; the pull requests behind it are tested again without it.

Restart the tests of a pull requestCopy Anchor Link

/cihub restart

Or cihub queue restart 123. It applies to a pull request whose test runs or failed and waits (testing, pending_failure): the queue runs its test again, for example after a fix of the CI. A pull request that left the queue needs a new submission instead.

Pause, drain and resume a queueCopy Anchor Link

The dashboard has the same actions on the page of the queue, and shows who paused it. These commands act on the queue of the default branch; add --branch release/2.0 for another one.

Follow the queue from the command lineCopy Anchor Link

cihub queue status        # the queue of the default branch
cihub queue status 123    # one pull request: its state, its reason, its position
cihub queue watch 123     # follows the pull request until it merges or fails
cihub queue watch         # follows the queue, until Ctrl-C
cihub queue graph         # the pull requests in the queue, and what each one is tested on top of

In a terminal, the commands write a table with colors; in a pipe, the rows alone, separated by tabs, for a script. --json writes what the API gives. NO_COLOR=1 turns the colors off. cihub queue watch 123 ends with the pull request: exit code 0 when it merges, 1 when it fails or is cancelled, so that a CI job can wait for the merge:

cihub queue merge 123 && cihub queue watch 123

Every cihub queue command finds the repository from the origin remote of git; --repo acme/web names another one. Install the command line, then sign in with cihub auth login.

Turn off a way to submitCopy Anchor Link

In .cihub.yaml, on a queue or in defaults:

commands_enabled: false # the comment commands and the checkbox
label_commands:
  enabled: false # the submission label