Merge Rules

Search…

Merge Rules

Merge rules are at the core of how the Aviator bot behaves. MergeQueue primarily relies on GitHub Labels to communicate with pull requests. There are several attributes that you can customize for each repository using a yaml configuration file.
Option 1: Dashboard UI
The best option for a quick setup is via the Merge Rules page. However, the UI does not expose all possible customizations.
Some of the Rules listed in the yaml configuration below are not supported in the Dashboard UI. Your repo will require using one of the configuration file options if you want to use advanced rules. We only recommend using the Dashboard UI option if you require a simple setup.
The only required setting is the Label for trigger -  this will default to mergequeue. Once you add this to a PR, Aviator will queue and merge the PR.
Label for trigger is the only required setting.
All of the settings in the UI are covered in the Rules section. Each setting also has a tooltip that provides more information.
Configuring Status Checks
See Required Checks under Merge Preconditions to set status checks for your PRs that need to be validated before merging. Selecting Use Github mergeability check will use all Github required tests for the repo.
Select Required status checks.
If your team is using Parallel mode, by default, Aviator bot will use the same checks for original PRs and draft PRs. However, if you want to customize checks for draft PRs, you can do so under Override required checks in the Parallel Mode section.
Override required checks for draft PRs.
Option 2: Dashboard Yaml Configuration
On the Merge Rules page, there is a Yaml configuration tab that allows you to both update and validate a configuration file.
Option 3: Create Yaml File within your repository
You can also create a configuration file stored in .mergequeue/config.yml. The file will only be read once it is merged into the repository's default branch. It will also override any properties set in the Dashboard UI. The only required attribute is merge_rules.labels.trigger.
Complete Yaml Configuration

Getting Started - Previous

FlakyBot

Attributes & Examples

Last modified 1mo ago

Copy link

On this page

Option 1: Dashboard UI

Option 2: Dashboard Yaml Configuration

Option 3: Create Yaml File within your repository