Request Reviews

Enhance your review workflow with customized, efficient, and dynamic review assignments tailored to your needs.

Mergify's request_reviews action provides an enhanced mechanism to automate and personalize your review process, taking it several notches above GitHub's conventional review assignment. By harnessing the versatility of pull request rules and conditions, you can define intricate workflows tailored to your team's needs. Let's explore how to utilize the action for various scenarios.

Below is a list of examples of what you could achieve with pull request rules and the request_reviews action.

Basic Assignment

Automatically request specific users or teams to review a pull request when it's labeled with review. The rule checks for a pull request labeled review and then requests reviews from user1, user2, and team1.

1
pull_request_rules:
2
  - name: request review from users 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

Dynamic reviewer assignments based on the content and context of pull requests.

File Type Based Review

Assign a Python expert to review changes in Python files.

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

Label Based Review

For security-focused pull requests, you might want specialized teams to review.

1
pull_request_rules:
2
  - name: ask the security teams 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

Evenly distribute the review workload among team members.

This rule assigns two random users from a list of four to review pull requests labeled as review.

1
pull_request_rules:
2
  - name: randomly ask two members for review
3
    conditions:
4
      - label=review
5
    actions:
6
      request_reviews:
7
        users:
8
          - jd
9
          - sileht
10
          - CamClrt
11
          - GuillaumeOj
12
        random_count: 2

Hierarchical Review System

Define a hierarchy in the review process, with junior team members reviewing first. If changes affect critical components, senior members step in.

1
pull_request_rules:
2
  - name: junior review for all PRs
3
    conditions:
4
      - base=main
5
    actions:
6
      request_reviews:
7
        users:
8
          - junior1
9
          - junior2
10

11
  - name: senior review for critical components
12
    conditions:
13
      - base=main
14
      - files~=^critical/
15
    actions:
16
      request_reviews:
17
        users:
18
          - seniorDev

Expertise-based Review Assignment

Ensure domain experts review relevant changes. If a PR modifies database-related files, request a review from the database expert.

1
pull_request_rules:
2
  - name: database expert review for database-related changes
3
    conditions:
4
      - files~=^database/
5
    actions:
6
      request_reviews:
7
        users:
8
          - dbExpert

Load Balancing Review Assignments

Distribute reviews more fairly, ensuring certain team members aren't overwhelmed.

1
pull_request_rules:
2
  - name: balanced review assignment
3
    conditions:
4
      - label=review
5
    actions:
6
      request_reviews:
7
        users:
8
          jd: 2
9
          sileht: 3
10
          CamClrt: 1
11
          GuillaumeOj: 1
12
        random_count: 2

Cross-Team Review

Facilitate cross-team collaboration and knowledge sharing. When core components are changed, it's beneficial to get insights from another team.

1
pull_request_rules:
2
  - name: cross-team review for core changes
3
    conditions:
4
      - files~=^core/
5
    actions:
6
      request_reviews:
7
        teams:
8
          - "@anotherTeam"

On-Demand Review Request

Allow authors to trigger specific domain reviews by adding labels.

1
pull_request_rules:
2
  - name: on-demand database expert review
3
    conditions:
4
      - label=request-db-review
5
    actions:
6
      request_reviews:
7
        teams:
8
          - dbExperts

Mentorship Review Process

Pull requests from new developers are first reviewed by mentors to ensure guidance.

1
pull_request_rules:
2
  - name: mentor review for new dev
3
    conditions:
4
      - author=newdev
5
    actions:
6
      request_reviews:
7
        users:
8
          - mentorUser

Collaborative Review Process

When critical files are modified, request multiple teams to collaboratively review the changes.

1
pull_request_rules:
2
  - name: multi-team review for critical changes
3
    conditions:
4
      - files~=^critical/
5
    actions:
6
      request_reviews:
7
        teams:
8
          - "@teamA"
9
          - "@teamB"

Time-Sensitive Review

PRs marked as urgent get reviewed by a dedicated quick response team.

1
pull_request_rules:
2
  - name: urgent review request
3
    conditions:
4
      - label=urgent
5
    actions:
6
      request_reviews:
7
        teams:
8
          - "@quickResponseTeam"

With these comprehensive use cases, you're well-equipped to optimize and customize your review workflows using Mergify's request_reviews action. Adapt and mix these scenarios to perfectly fit your team's unique requirements.

Edit on GitHub