Assign

The assign action allows you to assign one or more users to a pull request when the conditions you specify are met. This can help automate the process of designating the right people to handle specific pull requests, based on your conditions.

Each entry in users, add_users or remove_users is a User: a GitHub login, or the {{ author }} variable to assign the pull request to its author. users is the older form of add_users and behaves the same way; prefer add_users in new rules.

When GitHub rejects the request outright rather than ignoring a login, the rule’s check run reports the GitHub error and stays pending while Mergify retries on the next evaluation. The action never reports a failure.

Mergify skips any login ending in [bot] when adding assignees, so a rule that assigns {{ author }} does nothing on a pull request opened by a bot. A login that appears in both add_users and remove_users cancels out: Mergify neither adds nor removes it.

GitHub allows at most 10 assignees on a pull request, so users and add_users accept up to 10 entries each. remove_users accepts up to 40.

Below is an example of how to use the assign action:

pull_request_rules:
  - name: assign PR to a user
    conditions:
      - "#files = 1"
    actions:
      assign:
        add_users:
          - "username1"
          - "username2"

Below is an example of how to use the assign action to assign a pull request to its author:

pull_request_rules:
  - name: assign PR to its author
    conditions:
      - "#files = 1"
    actions:
      assign:
        add_users:
          - "{{ author }}"