@backstage/plugin-scaffolder-backend-module-github 0.2.8-next.2 → 0.2.9-next.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.2.9-next.0
+
+### Patch Changes
+
+- f145a04: Added handling for dry run to githubPullRequest and githubWebhook and added tests for this functionality
+- Updated dependencies
+  - @backstage/backend-common@0.22.1-next.0
+  - @backstage/backend-plugin-api@0.6.19-next.0
+  - @backstage/plugin-scaffolder-node@0.4.5-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.11.0
+
+## 0.2.8
+
+### Patch Changes
+
+- 5d99272: Update local development dependencies.
+- d229dc4: Move path utilities from `backend-common` to the `backend-plugin-api` package.
+- 52ab241: Adding support to change the default commit author for `publish:github:pull-request`
+- Updated dependencies
+  - @backstage/backend-common@0.22.0
+  - @backstage/backend-plugin-api@0.6.18
+  - @backstage/plugin-scaffolder-node@0.4.4
+  - @backstage/integration@1.11.0
+
 ## 0.2.8-next.2
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -10,7 +10,6 @@ var Sodium = require('libsodium-wrappers');
 var yaml = require('yaml');
 var webhooks = require('@octokit/webhooks');
 var path = require('path');
-var backendCommon = require('@backstage/backend-common');
 var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-scaffolder-node/alpha');
@@ -58,7 +57,7 @@ const enableBranchProtectionOnDefaultRepoBranch = async ({
           strict: requireBranchesToBeUpToDate,
           contexts: requiredStatusCheckContexts
         },
-        restrictions: restrictions != null ? restrictions : null,
+        restrictions: restrictions ?? null,
         enforce_admins: enforceAdmins,
         required_pull_request_reviews: {
           required_approving_review_count: requiredApprovingReviewCount,
@@ -104,7 +103,6 @@ function entityRefToName(name) {
 
 const DEFAULT_TIMEOUT_MS = 6e4;
 async function getOctokitOptions(options) {
-  var _a;
   const { integrations, credentialsProvider, repoUrl, token } = options;
   const { owner, repo, host } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
   const requestOptions = {
@@ -114,7 +112,7 @@ async function getOctokitOptions(options) {
   if (!owner) {
     throw new errors.InputError(`No owner provided for repo ${repoUrl}`);
   }
-  const integrationConfig = (_a = integrations.github.byHost(host)) == null ? void 0 : _a.config;
+  const integrationConfig = integrations.github.byHost(host)?.config;
   if (!integrationConfig) {
     throw new errors.InputError(`No integration for host ${host}`);
   }
@@ -126,7 +124,7 @@ async function getOctokitOptions(options) {
       request: requestOptions
     };
   }
-  const githubCredentialsProvider = credentialsProvider != null ? credentialsProvider : integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+  const githubCredentialsProvider = credentialsProvider ?? integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
   const { token: credentialProviderToken } = await githubCredentialsProvider.getCredentials({
     url: `https://${host}/${encodeURIComponent(owner)}/${encodeURIComponent(
       repo
@@ -147,7 +145,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
   const user = await client.rest.users.getByUsername({
     username: owner
   });
-  if (access == null ? void 0 : access.startsWith(`${owner}/`)) {
+  if (access?.startsWith(`${owner}/`)) {
     await validateAccessTeam(client, access);
   }
   const repoCreationPromise = user.data.type === "Organization" ? client.rest.repos.createInOrg({
@@ -198,7 +196,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
       `Failed to create the ${user.data.type} repository ${owner}/${repo}, ${e.message}`
     );
   }
-  if (access == null ? void 0 : access.startsWith(`${owner}/`)) {
+  if (access?.startsWith(`${owner}/`)) {
     const [, team] = access.split("/");
     await client.rest.teams.addOrUpdateRepoPermissionsInOrg({
       org: owner,
@@ -255,7 +253,7 @@ async function createGithubRepoWithCollaboratorsAndTopics(client, repo, owner, r
       logger.warn(`Skipping topics ${topics.join(" ")}, ${e.message}`);
     }
   }
-  for (const [key, value] of Object.entries(repoVariables != null ? repoVariables : {})) {
+  for (const [key, value] of Object.entries(repoVariables ?? {})) {
     await client.rest.actions.createRepoVariable({
       owner,
       repo,
@@ -1319,6 +1317,7 @@ function createGithubWebhookAction(options) {
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
     examples: examples$5,
+    supportsDryRun: true,
     schema: {
       input: {
         type: "object",
@@ -1406,6 +1405,10 @@ function createGithubWebhookAction(options) {
           token: providedToken
         })
       );
+      if (ctx.isDryRun) {
+        ctx.logger.info(`Dry run complete`);
+        return;
+      }
       try {
         const insecure_ssl = insecureSsl ? "1" : "0";
         await client.rest.repos.createWebhook({
@@ -1734,7 +1737,7 @@ function createGithubEnvironmentAction(options) {
         owner,
         repo,
         environment_name: name,
-        deployment_branch_policy: deploymentBranchPolicy != null ? deploymentBranchPolicy : null
+        deployment_branch_policy: deploymentBranchPolicy ?? null
       });
       if (customBranchPolicyNames) {
         for (const item of customBranchPolicyNames) {
@@ -1746,7 +1749,7 @@ function createGithubEnvironmentAction(options) {
           });
         }
       }
-      for (const [key, value] of Object.entries(environmentVariables != null ? environmentVariables : {})) {
+      for (const [key, value] of Object.entries(environmentVariables ?? {})) {
         await client.rest.actions.createEnvironmentVariable({
           repository_id: repository.data.id,
           environment_name: name,
@@ -1949,6 +1952,65 @@ const examples$2 = [
       ]
     })
   },
+  {
+    description: "Create a pull request with a git author name and email",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            gitAuthorName: "Foo Bar",
+            gitAuthorEmail: "foo@bar.example"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with a git author name",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            // gitAuthorEmail will be 'scaffolder@backstage.io'
+            // once one author attribute has been set we need to set both
+            gitAuthorName: "Foo Bar"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with a git author email",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            // gitAuthorName will be 'Scaffolder'
+            // once one author attribute has been set we need to set both
+            gitAuthorEmail: "foo@bar.example"
+          }
+        }
+      ]
+    })
+  },
   {
     description: "Create a pull request with all parameters",
     example: yaml__default.default.stringify({
@@ -1968,7 +2030,9 @@ const examples$2 = [
             token: "gph_YourGitHubToken",
             reviewers: ["foobar"],
             teamReviewers: ["team-foo"],
-            commitMessage: "Commit for foo changes"
+            commitMessage: "Commit for foo changes",
+            gitAuthorName: "Foo Bar",
+            gitAuthorEmail: "foo@bar.example"
           }
         }
       ]
@@ -2005,11 +2069,13 @@ const createPublishGithubPullRequestAction = (options) => {
   const {
     integrations,
     githubCredentialsProvider,
-    clientFactory = defaultClientFactory
+    clientFactory = defaultClientFactory,
+    config
   } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
     examples: examples$2,
+    supportsDryRun: true,
     schema: {
       input: {
         required: ["repoUrl", "title", "description", "branchName"],
@@ -2090,6 +2156,16 @@ const createPublishGithubPullRequestAction = (options) => {
             type: "boolean",
             title: "Force Fork",
             description: "Create pull request from a fork"
+          },
+          gitAuthorName: {
+            type: "string",
+            title: "Default Author Name",
+            description: "Sets the default author name for the commit. The default value is the authenticated user or 'Scaffolder'"
+          },
+          gitAuthorEmail: {
+            type: "string",
+            title: "Default Author Email",
+            description: "Sets the default author email for the commit. The default value is the authenticated user or 'scaffolder@backstage.io'"
           }
         }
       },
@@ -2129,7 +2205,9 @@ const createPublishGithubPullRequestAction = (options) => {
         teamReviewers,
         commitMessage,
         update,
-        forceFork
+        forceFork,
+        gitAuthorEmail,
+        gitAuthorName
       } = ctx.input;
       const { owner, repo, host } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -2145,7 +2223,7 @@ const createPublishGithubPullRequestAction = (options) => {
         repo,
         token: providedToken
       });
-      const fileRoot = sourcePath ? backendCommon.resolveSafeChildPath(ctx.workspacePath, sourcePath) : ctx.workspacePath;
+      const fileRoot = sourcePath ? backendPluginApi.resolveSafeChildPath(ctx.workspacePath, sourcePath) : ctx.workspacePath;
       const directoryContents = await pluginScaffolderNode.serializeDirectoryContents(fileRoot, {
         gitignore: true
       });
@@ -2176,6 +2254,14 @@ const createPublishGithubPullRequestAction = (options) => {
           }
         ])
       );
+      if (ctx.isDryRun) {
+        ctx.logger.info(`Performing dry run of creating pull request`);
+        ctx.output("targetBranchName", branchName);
+        ctx.output("remoteUrl", repoUrl);
+        ctx.output("pullRequestNumber", 43);
+        ctx.logger.info(`Dry run complete`);
+        return;
+      }
       try {
         const createOptions = {
           owner,
@@ -2184,7 +2270,7 @@ const createPublishGithubPullRequestAction = (options) => {
           changes: [
             {
               files,
-              commit: commitMessage != null ? commitMessage : title
+              commit: commitMessage ?? config?.getOptionalString("scaffolder.defaultCommitMessage") ?? title
             }
           ],
           body: description,
@@ -2193,6 +2279,29 @@ const createPublishGithubPullRequestAction = (options) => {
           update,
           forceFork
         };
+        const gitAuthorInfo = {
+          name: gitAuthorName ?? config?.getOptionalString("scaffolder.defaultAuthor.name"),
+          email: gitAuthorEmail ?? config?.getOptionalString("scaffolder.defaultAuthor.email")
+        };
+        if (gitAuthorInfo.name || gitAuthorInfo.email) {
+          if (Array.isArray(createOptions.changes)) {
+            createOptions.changes = createOptions.changes.map((change) => ({
+              ...change,
+              author: {
+                name: gitAuthorInfo.name || "Scaffolder",
+                email: gitAuthorInfo.email || "scaffolder@backstage.io"
+              }
+            }));
+          } else {
+            createOptions.changes = {
+              ...createOptions.changes,
+              author: {
+                name: gitAuthorInfo.name || "Scaffolder",
+                email: gitAuthorInfo.email || "scaffolder@backstage.io"
+              }
+            };
+          }
+        }
         if (targetBranchName) {
           createOptions.base = targetBranchName;
         }
@@ -2221,7 +2330,6 @@ const createPublishGithubPullRequestAction = (options) => {
     }
   });
   async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger) {
-    var _a, _b, _c, _d;
     try {
       const result = await client.rest.pulls.requestReviewers({
         owner: pr.owner,
@@ -2230,8 +2338,8 @@ const createPublishGithubPullRequestAction = (options) => {
         reviewers,
         team_reviewers: teamReviewers ? [...new Set(teamReviewers)] : void 0
       });
-      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 : "";
+      const addedUsers = result.data.requested_reviewers?.join(", ") ?? "";
+      const addedTeams = result.data.requested_teams?.join(", ") ?? "";
       logger.info(
         `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`
       );
@@ -2456,7 +2564,7 @@ function createPublishGithubAction(options) {
         dismissStaleReviews,
         requiredCommitSigning
       );
-      ctx.output("commitHash", commitResult == null ? void 0 : commitResult.commitHash);
+      ctx.output("commitHash", commitResult?.commitHash);
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
     }
@@ -2596,7 +2704,8 @@ const githubModule = backendPluginApi.createBackendModule({
           }),
           createPublishGithubPullRequestAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            config
           })
         );
       }