Label

Add, remove and toggle labels on a pull request.

The label action allows Mergify to automatically add or remove labels from a pull request based on the conditions specified in your rules, making your workflow more organized and efficient.

Parameters

Key name	Value type	Default
`add`	list of template
The list of labels to add.
`remove`	list of template
The list of labels to remove.
`toggle`	list of template
Toggle labels in the list based on the conditions. If all the conditions are a success, all the labels in the list will be added, otherwise, they will all be removed.
`remove_all`	boolean	`false`
Remove all labels from the pull request.

Examples

WIP

1
pull_request_rules:
2
  - name: add "WIP" label when the title contains "WIP"
3
    conditions:
4
      - title~=WIP
5
    actions:
6
      label:
7
        toggle:
8
          - WIP

In this example, Mergify will automatically add the "WIP" label to any pull request whose title contains "WIP". If the pull request does not match the rule anymore, the label will be removed.

Warn on Conflicts

When browsing the list of pull request, GitHub does not give any indication on which pull requests might be in conflict. Mergify allows to do this easily by adding a label.

1
pull_request_rules:
2
  - name: warn on conflicts
3
    conditions:
4
      - conflict
5
    actions:
6
      comment:
7
        message: "@{{author}} this pull request is now in conflict 😩"
8
      label:
9
        toggle:
10
          - conflict

Then, your pull request list will look like this on conflict:

Pull request in conflict in pull request list

Toggle A Label Based on CI Status

This rule toggle a label based on the failure status of a CI system.

1
pull_request_rules:
2
  - name: toggle labels based on CI state
3
    conditions:
4
      - check-failure=CI
5
    actions:
6
      label:
7
        toggle:
8
          - "CI:fail"

Add A Label Based on The Name of The Branch

This rule add a label with the name of the branch.

1
pull_request_rules:
2
  - name: add a label with the name of the branch
3
    conditions: []
4
    actions:
5
      label:
6
        add:
7
          - "branch:{{base}}"

Edit on GitHub