View as Markdown

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.

Who Gets Requested

Section titled Who Gets Requested

Mergify never requests a review from the pull request author, even when the author is named in users. It also skips anyone already involved: a user or team that has a pending review request, and any user who has approved, requested changes, or commented in a review on the pull request, even if that review was later dismissed. As with the review conditions, only reviewers with admin, write or maintain permission on the repository count here.

With random_count, those already-involved candidates count toward the target rather than being replaced. If random_count is 3 and two people from your lists have already reviewed, Mergify picks one more.

Parameters

Section titled Parameters
bot_account#Bot account or null·defaultnull

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#integer or null·defaultnull

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.

teams#list of string or map of integer

The team names to request reviews from.

users#list of string or map of integer

The usernames to request reviews from.

users_from_teams#list of string or map of integer

The team names to get the list of users to request reviews from.

Examples

Section titled Examples

Request a Review for Sensitive Files

Section titled Request a Review for Sensitive Files

Ask the security team to review whenever a pull request changes files under security/.

pull_request_rules:
  - name: request a security review
    conditions:
      - files ~= ^security/
    actions:
      request_reviews:
        teams:
          - security

Was this page helpful?

Edit this page on GitHub