Request Reviews

Request reviews from specific users or teams.

The request_reviews action lets Mergify request reviews from specified users or teams. This is useful when you want to ensure specific team members review certain pull requests.

Note

GitHub does not allow to request more than 15 users or teams for a review.

Parameters

Key name	Value type	Default
`users`	list of string or list of object
The username to request reviews from.
`users_from_teams`	list of string or list of object
The team names to get the list of users to request reviews from.
`teams`	list of string or list of object
The team name to request reviews from.
`bot_account`	template
Mergify can impersonate a GitHub user to request a review on a pull request. If no `bot_account` is set, Mergify will request the review itself.
`random_count`	number
Pick random users and teams from the provided lists. When `random_count` is specified, `users` and `teams` can be a dictionary where the key is the login and the value is the weight to use. Weight must be between 1 and 65535 included.

Examples

Basic Assignment

Here's an example of how to use the request_reviews action:

1
pull_request_rules:
2
  - name: request review from user and team when pull request is labeled with `review`
3
    conditions:
4
      - label=review
5
    actions:
6
      request_reviews:
7
        users:
8
          - user1
9
          - user2
10
        teams:
11
          - team1

Flexible Reviewers Assignment

You can assign people for review based on any criteria you like. A classic is to use the name of modified files to do it:

1
pull_request_rules:
2
  - name: ask jd to review changes on python files
3
    conditions:
4
      - files~=\.py$
5
    actions:
6
      request_reviews:
7
        users:
8
          - jd

You can also ask entire teams to review a pull request based on, e.g., labels:

1
pull_request_rules:
2
  - name: ask the security team to review security labeled PR
3
    conditions:
4
      - label=security
5
    actions:
6
      request_reviews:
7
        teams:
8
          - "@myorg/security-dev"
9
          - "@myorg/security-ops"

Random Review Assignment

It's not fair to ask for the same users or teams to always do the review. You can rather randomly assign a pull request to a group of users.

1
pull_request_rules:
2
  - name: ask the security team to review security labeled PR
3
    conditions:
4
      - label=security
5
    actions:
6
      request_reviews:
7
        users:
8
          - jd
9
          - sileht
10
          - CamClrt
11
          - GuillaumeOj
12
       random_count: 2

In that case, 2 users from this list of 4 users will get a review requested for this pull request.

If you prefer some users to have a larger portion of the pull requests assigned, you can add a weight to the user list:

1
pull_request_rules:
2
  - name: ask the security team to review security labeled PR
3
    conditions:
4
      - label=security
5
    actions:
6
      request_reviews:
7
        users:
8
          jd: 2
9
          sileht: 3
10
          CamClrt: 1
11
          GuillaumeOj: 1
12
      random_count: 2

In that case, it's 3 times more likely then the user sileht will get a pull request assigned rather than GuillaumeOj.

Edit on GitHub