Company
Word count
345
Language
English
Contains code?

Text

MergeQueue communicates with pull request using GitHub labels, GitHub comments and the Aviator CLI . Merge rules are at the core of how the Aviator bot reacts to the actions taken on GitHub. Some of the Basic Configuration can be modified using the Merge Rules dashboard . For more advanced configuration, Aviator supports a YAML based configuration file. This file can either be applied directly from the Aviator dashboard or configured in the GitHub repository. Managing YAML from the dashboard You can directly apply the config on the YAML configuration tab on the Merge Rules page. We also recommend validating this configuration before applying any changes. Managing YAML from GitHub repository You can also create a configuration file stored in

.aviator/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. Config Schema You can see the complete config schema as well as the JSON schema for autocompletion and validation purpose. Examples Find below some common examples to get you started. Minimalist config The only required attribute is

merge_rules.labels.trigger

. Custom required checks Checkout customizing required checks section for details. Require all conversation resolution This enforces all conversations in GitHub to be resolved before the PR can be merged. No approval Useful for testing. Aviator will only be able to merge PR if the approval is not enforced at GitHub level. By default, Aviator always require approvals. Using Parallel mode Also checkout the parallel mode section for details. Automatic requeue On failure, the PRs will automatically requeue before giving up. Only available in parallel mode. Auto update Keep your PRs up to date. Every time a new commit is added to the base branch, the PRs are automatically updated using rebase or merge commit. See

merge_rules.auto_update

in the configuration schema reference . Custom title and body Customize title and body when merging the PR. Previous Getting Started with MergeQueue Next How-to Guides for MergeQueue Last updated 12 months ago Was this helpful?

Analysis

No analysis created yet for this page.