Search…
⌃K
Links

Configuration file

Applying the config

If you are looking for more customization options, you may want to use the YAML based configuration file. There are two ways to set up a configuration file.

From dashboard

You can directly apply the config on the Yaml configuration tab on the Merge Rules page. Here you can also validate this configuration before applying.
applying YAML configuration from dashboard

From GitHub 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.

Rules

Labels

merge_rules:
labels:
trigger: "label_name"
skip_line: "skip_line"
merge_failed: "blocked"
skip_delete_branch: "do-not-delete"
Attributes
Name
Type
Description
trigger
String
(Required). This label is used to identify that a pull request is ready to be processed by Aviator bot. Once labeled, the bot will verify that the PR has passed all the required conditions and then merge the PR.
skip_line
String
When tagged with this label, Aviator bot will move the PR to the front of the queue.
merge_failed
String
If the pull request fails to merge, Aviator bot will add this label.
skip_delete_branch
String
If delete_branch is enabled, Aviator bot will skip deleting a branch with this label after merging.

Preconditions

merge_rules:
labels:
trigger: "label_name"
preconditions:
number_of_approvals: 1
required_checks:
# Note: both a string or a more detailed conditional check is accepted
# for conditional_check, both skipped and success are considered passing
- check_1
- name: conditional_check
acceptable_statuses:
- skipped
- success
use_github_mergeability: true
conversation_resolution_required: false
validations:
- name: missing JIRA ticket in PR title
match:
type: title
regex:
- -\s\[[^\]]*\]
- ()
- name: validation_body
match:
type: body
regex:
- -\s\[[^\]]*\]yam
Attributes
Name
Type
Description
number_of_approvals
Integer
Minimum number of reviewers that should approve the PullRequest before it can qualify to be merged. Defaults to 1.
required_checks
List[Union[String, ConditionalCheck]]
Checks that need to pass before Aviator bot will merge the PR. Also supports other acceptable CI statuses if your repo uses conditional status checks. See the Example tab.
use_github_mergeability
Boolean
Determines whether to use the default required checks specified in branch protection rules on GitHub. When this setting is enabled, Aviator bot will ignore required_checks. Defaults to true.
conversation_resolution_required
Boolean
Determines whether Aviator bot will queue the PR only after all conversations are resolved.
validations
List[Validation]
Custom validation rules using regexes for the PR body or title. See the Example tab for more details.

Merge Modes

Name
Type
Description
type
String
Determines the mode. Options are: default, parallel, no-queue.

Parallel Mode

The following are only applicable if the above merge_mode is set to parallel. You can learn more about Parallel Mode here.
merge_rules:
labels:
trigger: "label_name"
merge_mode:
type: "parallel" # other modes: "default", "no-queue"
parallel_mode:
use_affected_targets: false
use_fast_forwarding: true
max_parallel_builds: 10
max_requeue_attempts: 3
stuck_pr_label: "label"
stuck_pr_timeout_mins: 90
block_parallel_builds_label: "block_batch"
check_mergeability_to_queue: false
override_required_checks:
- "check 1"
- check_2
# Note: both a string or a more detailed conditional check is accepted
# for conditional_check, both skipped and success are considered passing
- name: conditional_check
acceptable_statuses:
- skipped
- success
Attributes
Name
Type
Description
max_parallel_builds
Integer
The maximum number of builds that Aviator bot will run at any time. Defaults to no limit.
max_requeue_attempts
Integer
The maximum number of times Aviator bot will requeue a CI run after failing. Note that PRs will only be requeued if the original PR CI is passing but the draft PR CI fails. Defaults to no requeuing.
stuck_pr_label
String
The label that Aviator bot will add if it determines a PR to be stuck.
stuck_pr_timeout_mins
Integer
Aviator bot will determine the PR to be stuck after the specified timeout and dequeue it. Defaults to no time out.
block_parallel_builds_label
String
Once added to a PR, no further Draft PRs will be built on top of it until that PR is merged or dequeued.
check_mergeability_to_queue
Boolean
If enabled, Aviator bot will only queue the PR if it passes all mergeability checks. Defaults to false.
use_affected_targets
Boolean
If enabled, allows using affected targets in your repo.
use_fast_forwarding
Boolean
If enabled, uses fast forwarding to merge PRs.
override_required_checks
List[Union[String, ConditionalCheck]]
Use this attribute if you would like different checks for your original PRs and draft PRs. The checks defined here will be used for the draft PRs created in Parallel mode. Also supports other acceptable CI statuses if your repo uses conditional status checks. See the Example tab.
batch_size
Integer
The number of queued PRs batched together for a draft PR CI run. Defaults to 1.
batch_max_wait_minutes
Integer
The time to wait before creating the next batch of PRs if there are not enough queued PRs to create a full batch. Defaults to 0.
require_all_draft_checks_pass
Boolean
Determines if Aviator will enforce all checks to pass for the constructed draft PRs. If true, any single failing test will cause the draft PR to fail. These checks include the ones we receive status updates for via Github. This may work well if your repo has conditional checks. Requires at least one check to be present. Defaults to false.

Auto Update

merge_rules:
labels:
trigger: "label_name"
auto_update:
enabled: true
label: "auto_update"
max_runs_for_update: 10
Attributes
Name
Type
Description
enabled
Boolean
If enabled, Aviator bot will keep your branches up to date with the main branch. Defaults to false.
label
String
Aviator bot will only keep branches with this label up to date with the main branch. Leave empty to auto merge without a label. If no label is provided and auto_update is enabled, by default the Aviator bot will update all PRs.
max_runs_for_update
Integer
The maximum number of times Aviator bot will update your branch. Defaults to no limit.

Merge Commit

merge_rules:
labels:
trigger: "label_name"
merge_commit:
use_title_and_body: true
cut_body_before: "----"
cut_body_after: "+++"
strip_html_comments: false
include_coauthors: true
apply_title_regexes:
- pattern: "AVTR-"
replace: "AVTR_"
- pattern: "MQ-BOT"
replace: "MQ BOT"
Attributes
Name
Type
Description
use_title_and_body
Boolean
Determines whether Aviator bot will replace default commit messages offered by Github. Defaults to false.
cut_body_before
String
A marker string to cut the PR body description. The commit message will contain the PR body after this marker. Leave empty for no cropping.
cut_body_after
String
A marker string to cut the PR body description. The commit message will contain the PR body before this marker. Leave empty for no cropping.
strip_html_comments
Boolean
Strip out the hidden HTML comments from the commit message when merging the PR. Defaults to false.
include_coauthors
Boolean
Include coauthors (if any) in the commit message when merging the PR. Defaults to true.
apply_title_regexes
List[ReplacePattern]
Contains the strings pattern and replace to indicate what pattern to replace in the PR title. This will be applied to the merge commit. In parallel mode, this also applies to the draft PR title. See the example tab for more details.

Merge Strategy

Name
Type
Description
name
String
Defines the merge strategy to use, the options are "squash", "merge", and "rebase". See the Github docs for more info.

Override Labels

You can specify overrides to the above merge strategy using Github Labels. When a PR is flagged with these labels along with the trigger label, Aviator bot will merge the PR using this strategy instead of the default strategy. Leave empty for no overrides.
merge_rules:
labels:
trigger: "label_name"
merge_strategy:
name: "squash"
override_labels:
squash: "mq-squash"
merge: "mq-merge-commit"
rebase: "mq-rebase"
Attributes
Name
Type
Description
squash
String
If marked with this label, the PR will be squashed and merged.
merge
String
If marked with this label, the PR will be merged using a merge commit.
rebase
String
If marked with this label, the PR will be rebased and merged.

Other

merge_rules:
labels:
trigger: "label_name"
update_latest: true
delete_branch: false
use_rebase: false
enable_comments: true
ci_timeout_mins: 60
base_branches:
- master
- /release-*/
Attributes
Name
Type
Description
update_latest
Boolean
Determines whether Aviator bot will merge the latest base branch into the current branch of your PR before verifying the CI statuses. This is only compatible with the default and no-queue merge modes. Defaults to true.
delete_branch
Boolean
Determines whether Aviator bot will delete the branch after merging. Defaults to false.
use_rebase
Boolean
Determines if Aviator bot will use rebase to update PRs. This feature is only available in the Pro plan. Please note that you also need to enable update_latest for rebase to work. Defaults to false.
publish_status_check
Boolean
Determines if Aviator bot will publish a status check back on the PR. This status check represents the current state of PR in the Aviator queue.
enable_comments
Boolean
Determines if Aviator bot can add comments on the PR to describe the actions performed on the PR by the bot. Aviator bot comments include information such as failure reasons and the position of the PR in the queue. Defaults to true.
ci_timeout_mins
Integer
The time before we determine that the CI has timed out. Defaults to no time out.
base_branches
List[String]
These branches are the ones that Aviator will monitor as valid branches to merge into. Defaults to your repository default branch as configured on GitHub. Regexes are allowed.
require_all_checks_pass
Boolean
Determines if Aviator will enforce all checks to pass. If true, any single failing test will cause the PR to fail. These checks include the ones we receive status updates for via Github. This may work well if your repo has conditional checks. Requires at least one check to be present. Defaults to false.