@backstage/plugin-scaffolder-backend 1.5.0-next.1 → 1.5.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.5.0-next.2
+
+### Minor Changes
+
+- 692d5d3405: Added `reviewers` and `teamReviewers` parameters to `publish:github:pull-request` action to add reviewers on the pull request created by the action
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.3.1-next.2
+
 ## 1.5.0-next.1
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.5.0-next.1",
+  "version": "1.5.0-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -513,6 +514,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -676,14 +679,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions

package/dist/index.beta.d.ts

@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -513,6 +514,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -676,14 +679,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions

package/dist/index.cjs.js

@@ -3055,6 +3055,22 @@ const createPublishGithubPullRequestAction = ({
             title: "Authentication Token",
             type: "string",
             description: "The token to use for authorization to GitHub"
+          },
+          reviewers: {
+            title: "Pull Request Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The users that will be added as reviewers to the pull request"
+          },
+          teamReviewers: {
+            title: "Pull Request Team Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The teams that will be added as reviewers to the pull request"
           }
         }
       },
@@ -3084,7 +3100,9 @@ const createPublishGithubPullRequestAction = ({
         draft,
         targetPath,
         sourcePath,
-        token: providedToken
+        token: providedToken,
+        reviewers,
+        teamReviewers
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -3132,13 +3150,46 @@ const createPublishGithubPullRequestAction = ({
         if (!response) {
           throw new GithubResponseError("null response from Github");
         }
+        const pullRequestNumber = response.data.number;
+        if (reviewers || teamReviewers) {
+          const pullRequest = { owner, repo, number: pullRequestNumber };
+          await requestReviewersOnPullRequest(
+            pullRequest,
+            reviewers,
+            teamReviewers,
+            client,
+            ctx.logger
+          );
+        }
         ctx.output("remoteUrl", response.data.html_url);
-        ctx.output("pullRequestNumber", response.data.number);
+        ctx.output("pullRequestNumber", pullRequestNumber);
       } catch (e) {
         throw new GithubResponseError("Pull request creation failed", e);
       }
     }
   });
+  async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger) {
+    var _a, _b, _c, _d;
+    try {
+      const result = await client.rest.pulls.requestReviewers({
+        owner: pr.owner,
+        repo: pr.repo,
+        pull_number: pr.number,
+        reviewers,
+        team_reviewers: teamReviewers
+      });
+      const addedUsers = (_b = (_a = result.data.requested_reviewers) == null ? void 0 : _a.join(", ")) != null ? _b : "";
+      const addedTeams = (_d = (_c = result.data.requested_teams) == null ? void 0 : _c.join(", ")) != null ? _d : "";
+      logger.info(
+        `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`
+      );
+    } catch (e) {
+      logger.error(
+        `Failure when adding reviewers to Pull request ${pr.number}`,
+        e
+      );
+    }
+  }
 };
 
 function createPublishGitlabAction(options) {