Getting Started
Reference
Slash Commands
Slash commands enable teams to manage their pull requests with Aviator directly from the GitHub pull request page. The commands are invoked by including the line
/aviator <command> anywhere in your comment (as long as it's on a line by itself). Only one slash command per comment is allowed.Slash command reference
Merge
The
/aviator merge command queues a PR for merging. This can be used instead of adding the ready label.Cancel
The
/aviator cancel command de-queues a PR that has been previously queued.When using the parallel queue mode, de-queuing a PR can negatively impact the performance of the queue (since any PR that was queued after the cancelled PR will have their CI reset).
Refresh
The
/aviator refresh command causes MergeQueue to re-examine your pull request. This can be useful if MergeQueue missed an event (such as you labeling your PR with the ready label).Usually this is only necessary if GitHub fails to deliver an event to MergeQueue (e.g., during a GitHub outage).
Stack Merge
The
/aviator stack merge command queues a stack for merging into the target branch of the stack (usually your repository default branch).When queueing a stack, MergeQueue internally queues the PR where the command was given and every PR that comes before it in the stack. The target branch of the stack (i.e., the branch where that the stack is being merged into) is the base branch of the first PR in the stack.
When merging a stack, any PRs that come later in the stack (after the PR where the stack merge command was issued) will have to be rebased using the
av command line tool.For example, if your stack consists of PR1 through PR5, and PR3 is queued, PR4 and PR5 will have to be rebased on top of the commit where PR3 was merged into the stack's target branch (e.g.,
main). This means that PR3 must be merged before PR4 or PR5 can be queued.Stack Cancel
The
aviator stack cancel command de-queues a stack that has been previously queued.Sync
The
/aviator sync command synchronizes the PR to be up-to-date with its base branch (i.e., creates a merge commit or rebases on top of the latest commit from the base branch, depending on your repository configuration).
Last modified 1mo ago
Copy link