Sharing Configuration

In Mergify, you can leverage certain features like YAML anchors and aliases, the shared key, and the extends key to reduce redundancy, maintain consistency, and increase code reusability.

YAML Anchors and Aliases

YAML anchors (&) and aliases (*) are supported in the configuration file. These allow you to reuse configuration sections. For example, you can create a list of continuous integration checks and use it in multiple sections:

1
queue_rules:
2
  - name: hotfix
3
    queue_conditions:
4
      - and: &CheckRuns
5
        - check-success=linters
6
        - check-success=unit
7
        - check-success=functionnal
8
        - check-success=e2e
9
        - check-success=docker
10
  - name: default
11
    queue_conditions:
12
      - and: *CheckRuns
13
      - schedule=Mon-Fri 09:00-17:30[Europe/Paris]

Sharing Configuration Sections

You can store anything in the shared key. Its main purpose is to provide a place to put redundant YAML anchors:

1
shared:
2
  my_ci: &common_checks
3
    - check-success=ci-one
4
    - check-success=ci-two
5

6
queue_rules:
7
  - name: hotfix
8
    queue_conditions:
9
      - and: *my_ci
10
  - name: default
11
    queue_conditions:
12
      - and: *my_ci
13
      - schedule=Mon-Fri 09:00-17:30[Europe/Paris]

Extending Configuration Files

Mergify lets you extend your configuration file by including the configuration from another repository. This feature is useful when you want to share and reuse configuration rules across multiple repositories, helping maintain consistency and reduce duplication.

To extend a configuration file, use the extends keyword at the top level of your configuration file file and specify the repository name from which you want to include the configuration.

1
extends: organization/shared-config

The configuration from the specified repository will be loaded and applied before the one in the current repository. Here's an example:

1
extends: organization/shared-config
2

3
pull_request_rules:
4
  - name: additional rule specific to this repository
5
    conditions:
6
      - base=main
7
    actions:
8
      label:
9
        add: ["repository-specific"]