feat(prepare): provide a config to assign team as reviewer (#619)

algolia · Jan 14, 2020 · 14ebf38 · 14ebf38
1 parent 8c92df2
commit 14ebf38
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/packages/shipjs-lib/src/lib/config/defaultConfig.js b/packages/shipjs-lib/src/lib/config/defaultConfig.js
@@ -67,6 +67,7 @@ export default {
     return lines.join('\n');
   },
   pullRequestReviewer: undefined,
+  pullRequestTeamReviewer: undefined,
   mergeStrategy: {
     toSameBranch: ['master'],
     // toReleaseBranch: {

diff --git a/packages/shipjs/src/step/prepare/createPullRequest.js b/packages/shipjs/src/step/prepare/createPullRequest.js
@@ -29,6 +29,7 @@ export default async ({
       formatPullRequestMessage,
       publishCommand,
       pullRequestReviewer,
+      pullRequestTeamReviewer,
       remote,
       monorepo,
     } = config;
@@ -87,6 +88,9 @@ export default async ({
     const reviewers = Array.isArray(pullRequestReviewer)
       ? pullRequestReviewer
       : (pullRequestReviewer || '').split(',');
+    const teamReviewers = Array.isArray(pullRequestTeamReviewer)
+      ? pullRequestTeamReviewer
+      : (pullRequestTeamReviewer || '').split(',');
     const octokit = new Octokit({
       auth: `token ${process.env.GITHUB_TOKEN}`,
     });
@@ -107,6 +111,7 @@ export default async ({
         repo,
         pull_number: number, // eslint-disable-line camelcase
         reviewers,
+        team_reviewers: teamReviewers, // eslint-disable-line camelcase
       });
     }
 

diff --git a/website/guide/useful-config.md b/website/guide/useful-config.md
@@ -180,9 +180,16 @@ You can assign reviewers on the PR.
 
 ```js
 module.exports = {
-  pullRequestReviewer: "user-name-or-team-name"
+  pullRequestReviewer: "user-login"
   // or
-  pullRequestReviewer: ["user1", "user2", "user3"]
+  pullRequestReviewer: ["user-login1", "user-login2", "user-login3"],
+
+  ...
+
+  // also
+  pullRequestTeamReviewer: "team-slug",
+  // or
+  pullRequestTeamReviewer: ["team-slug1", "team-slug2"],
 };
 ```