Prevent review requests from teams and users

README.md

@@ -88,6 +88,13 @@ inputs:
 rules:
   - name: A single approval
     min_approvals: 1
+
+# OPTIONAL: define teams or users whose reviews are not requested by the action
+prevent_review_requests:
+  users:
+    - user_name
+  teams:
+    - team_name
 ```
 
 ### Rules syntax <a name="rules-syntax"></a>

src/core.ts

@@ -137,6 +137,7 @@ export const runChecks = async function (
       "action-review-team": actionReviewTeam,
     },
     rules,
+    prevent_review_requests: preventReviewRequests,
   } = configValidationResult.value
 
   // Set up a teams cache so that teams used multiple times don't have to be
@@ -626,23 +627,29 @@ export const runChecks = async function (
       const users: Set<string> = new Set()
       for (const [user, userInfo] of usersToAskForReview) {
         if (userInfo.teams === null) {
-          users.add(user)
+          if (!preventReviewRequests?.users?.includes(user)) {
+            users.add(user)
+          }
         } else {
           for (const team of userInfo.teams) {
-            teams.add(team)
+            if (!preventReviewRequests?.teams?.includes(team)) {
+              teams.add(team)
+            }
           }
         }
       }
-      await octokit.request(
-        "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
-        {
-          owner: pr.base.repo.owner.login,
-          repo: pr.base.repo.name,
-          pull_number: pr.number,
-          reviewers: Array.from(users),
-          team_reviewers: Array.from(teams),
-        },
-      )
+      if (users.size || teams.size) {
+        await octokit.request(
+          "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+          {
+            owner: pr.base.repo.owner.login,
+            repo: pr.base.repo.name,
+            pull_number: pr.number,
+            reviewers: Array.from(users),
+            team_reviewers: Array.from(teams),
+          },
+        )
+      }
     }
 
     if (highestMinApprovalsRule !== null) {

src/types.ts

@@ -84,7 +84,18 @@ export type RulesConfigurations = {
 
 export type Configuration = {
   rules: Rule[]
-  inputs: Inputs
+  inputs: {
+    "locks-review-team": string
+    "team-leads-team": string
+    "action-review-team": string
+  }
+  prevent_review_requests:
+    | {
+        users: string[]
+        teams: string[]
+      }
+    | undefined
+    | null
 }
 
 export type RuleUserInfo = {
@@ -118,9 +129,3 @@ export class RuleFailure {
     public usersToAskForReview: Map<string, RuleUserInfo>,
   ) {}
 }
-
-export type Inputs = {
-  "locks-review-team": string
-  "team-leads-team": string
-  "action-review-team": string
-}

src/validation.ts

@@ -5,7 +5,6 @@ import {
   AndRule,
   BasicRule,
   Configuration,
-  Inputs,
   OrRule,
   RuleCriteria,
 } from "./types"
@@ -78,10 +77,19 @@ const ruleSchema = Joi.alternatives([
 ])
 
 export const configurationSchema = Joi.object<Configuration>().keys({
-  inputs: Joi.object<Inputs>().keys({
+  inputs: Joi.object<Configuration["inputs"]>().keys({
     "locks-review-team": Joi.string().required(),
     "team-leads-team": Joi.string().required(),
     "action-review-team": Joi.string().required(),
   }),
   rules: Joi.array().items(ruleSchema).required(),
+  prevent_review_requests: Joi.object<
+    Configuration["prevent_review_requests"]
+  >()
+    .keys({
+      users: Joi.array().items(Joi.string()).optional().allow(null),
+      teams: Joi.array().items(Joi.string()).optional().allow(null),
+    })
+    .optional()
+    .allow(null),
 })