@backstage/plugin-scaffolder-backend-module-github 0.6.1-next.2 → 0.6.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.6.1
+
+### Patch Changes
+
+- 11bc3e6: Made "github:pages:enable" action idempotent
+- 3f45e0f: Made "github:environment:create" action idempotent
+- 09cf038: Got rid of most `@backstage/backend-common` usages
+- 8c38687: Made "github:issues:label" action idempotent
+- 89948b2: Made "github:repo:push" action idempotent
+- 9391f58: Pass `undefined` to some parameters for `createOrUpdateEnvironment` as these values are not always supported in different plans of GitHub
+- 8182a59: Made "github:webhook" action idempotent
+- 8f9c54c: Made "github:repo:create" action idempotent
+- 0ae0c77: Made "publish:github:pull-request" action idempotent
+- Updated dependencies
+  - @backstage/integration@1.16.2
+  - @backstage/plugin-scaffolder-node@0.8.0
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-client@1.9.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
 ## 0.6.1-next.2
 
 ### Patch Changes

package/dist/actions/githubEnvironment.cjs.js

@@ -137,9 +137,15 @@ Wildcard characters will not match \`/\`. For example, to match tags that begin
         repo
       });
       const client = new octokit.Octokit(octokitOptions);
-      const repository = await client.rest.repos.get({
-        owner,
-        repo
+      const repositoryId = await ctx.checkpoint({
+        key: `get.repo.${owner}.${repo}`,
+        fn: async () => {
+          const repository = await client.rest.repos.get({
+            owner,
+            repo
+          });
+          return repository.data.id;
+        }
       });
       const githubReviewers = [];
       if (reviewers) {
@@ -158,25 +164,37 @@ Wildcard characters will not match \`/\`. For example, to match tags that begin
         for (const reviewerEntityRef of reviewersEntityRefs) {
           if (reviewerEntityRef?.kind === "User") {
             try {
-              const user = await client.rest.users.getByUsername({
-                username: reviewerEntityRef.metadata.name
+              const userId = await ctx.checkpoint({
+                key: `get.user.${reviewerEntityRef.metadata.name}`,
+                fn: async () => {
+                  const user = await client.rest.users.getByUsername({
+                    username: reviewerEntityRef.metadata.name
+                  });
+                  return user.data.id;
+                }
               });
               githubReviewers.push({
                 type: "User",
-                id: user.data.id
+                id: userId
               });
             } catch (error) {
               ctx.logger.error("User not found:", error);
             }
           } else if (reviewerEntityRef?.kind === "Group") {
             try {
-              const team = await client.rest.teams.getByName({
-                org: owner,
-                team_slug: reviewerEntityRef.metadata.name
+              const teamId = await ctx.checkpoint({
+                key: `get.team.${reviewerEntityRef.metadata.name}`,
+                fn: async () => {
+                  const team = await client.rest.teams.getByName({
+                    org: owner,
+                    team_slug: reviewerEntityRef.metadata.name
+                  });
+                  return team.data.id;
+                }
               });
               githubReviewers.push({
                 type: "Team",
-                id: team.data.id
+                id: teamId
               });
             } catch (error) {
               ctx.logger.error("Team not found:", error);
@@ -184,57 +202,86 @@ Wildcard characters will not match \`/\`. For example, to match tags that begin
           }
         }
       }
-      await client.rest.repos.createOrUpdateEnvironment({
-        owner,
-        repo,
-        environment_name: name,
-        deployment_branch_policy: deploymentBranchPolicy ?? void 0,
-        wait_timer: waitTimer ?? void 0,
-        prevent_self_review: preventSelfReview ?? void 0,
-        reviewers: githubReviewers.length ? githubReviewers : void 0
-      });
-      if (customBranchPolicyNames) {
-        for (const item of customBranchPolicyNames) {
-          await client.rest.repos.createDeploymentBranchPolicy({
+      await ctx.checkpoint({
+        key: `create.or.update.environment.${owner}.${repo}.${name}`,
+        fn: async () => {
+          await client.rest.repos.createOrUpdateEnvironment({
             owner,
             repo,
-            type: "branch",
             environment_name: name,
-            name: item
+            deployment_branch_policy: deploymentBranchPolicy ?? void 0,
+            wait_timer: waitTimer ?? void 0,
+            prevent_self_review: preventSelfReview ?? void 0,
+            reviewers: githubReviewers.length ? githubReviewers : void 0
+          });
+        }
+      });
+      if (customBranchPolicyNames) {
+        for (const item of customBranchPolicyNames) {
+          await ctx.checkpoint({
+            key: `create.deployment.branch.policy.branch.${owner}.${repo}.${name}.${item}`,
+            fn: async () => {
+              await client.rest.repos.createDeploymentBranchPolicy({
+                owner,
+                repo,
+                type: "branch",
+                environment_name: name,
+                name: item
+              });
+            }
           });
         }
       }
       if (customTagPolicyNames) {
         for (const item of customTagPolicyNames) {
-          await client.rest.repos.createDeploymentBranchPolicy({
-            owner,
-            repo,
-            type: "tag",
-            environment_name: name,
-            name: item
+          await ctx.checkpoint({
+            key: `create.deployment.branch.policy.tag.${owner}.${repo}.${name}.${item}`,
+            fn: async () => {
+              await client.rest.repos.createDeploymentBranchPolicy({
+                owner,
+                repo,
+                type: "tag",
+                environment_name: name,
+                name: item
+              });
+            }
           });
         }
       }
       for (const [key, value] of Object.entries(environmentVariables ?? {})) {
-        await client.rest.actions.createEnvironmentVariable({
-          repository_id: repository.data.id,
-          owner,
-          repo,
-          environment_name: name,
-          name: key,
-          value
+        await ctx.checkpoint({
+          key: `create.env.variable.${owner}.${repo}.${name}.${key}`,
+          fn: async () => {
+            await client.rest.actions.createEnvironmentVariable({
+              repository_id: repositoryId,
+              owner,
+              repo,
+              environment_name: name,
+              name: key,
+              value
+            });
+          }
         });
       }
       if (secrets) {
-        const publicKeyResponse = await client.rest.actions.getEnvironmentPublicKey({
-          repository_id: repository.data.id,
-          owner,
-          repo,
-          environment_name: name
+        const { publicKey, publicKeyId } = await ctx.checkpoint({
+          key: `get.env.public.key.${owner}.${repo}.${name}`,
+          fn: async () => {
+            const publicKeyResponse = await client.rest.actions.getEnvironmentPublicKey({
+              repository_id: repositoryId,
+              owner,
+              repo,
+              environment_name: name
+            });
+            return {
+              publicKey: publicKeyResponse.data.key,
+              publicKeyId: publicKeyResponse.data.key_id
+            };
+          }
         });
         await Sodium__default.default.ready;
         const binaryKey = Sodium__default.default.from_base64(
-          publicKeyResponse.data.key,
+          publicKey,
           Sodium__default.default.base64_variants.ORIGINAL
         );
         for (const [key, value] of Object.entries(secrets)) {
@@ -247,14 +294,19 @@ Wildcard characters will not match \`/\`. For example, to match tags that begin
             encryptedBinarySecret,
             Sodium__default.default.base64_variants.ORIGINAL
           );
-          await client.rest.actions.createOrUpdateEnvironmentSecret({
-            repository_id: repository.data.id,
-            owner,
-            repo,
-            environment_name: name,
-            secret_name: key,
-            encrypted_value: encryptedBase64Secret,
-            key_id: publicKeyResponse.data.key_id
+          await ctx.checkpoint({
+            key: `create.or.update.env.secret.${owner}.${repo}.${name}.${key}`,
+            fn: async () => {
+              await client.rest.actions.createOrUpdateEnvironmentSecret({
+                repository_id: repositoryId,
+                owner,
+                repo,
+                environment_name: name,
+                secret_name: key,
+                encrypted_value: encryptedBase64Secret,
+                key_id: publicKeyId
+              });
+            }
           });
         }
       }

package/dist/actions/githubEnvironment.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubEnvironment.cjs.js","sources":["../../src/actions/githubEnvironment.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { getOctokitOptions } from '../util';\nimport { Octokit } from 'octokit';\nimport Sodium from 'libsodium-wrappers';\nimport { examples } from './gitHubEnvironment.examples';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport { Entity } from '@backstage/catalog-model';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\n/**\n * Creates an `github:environment:create` Scaffolder action that creates a Github Environment.\n *\n * @public\n */\nexport function createGithubEnvironmentAction(options: {\n  integrations: ScmIntegrationRegistry;\n  catalogClient?: CatalogApi;\n  auth?: AuthService;\n}) {\n  const { integrations, catalogClient, auth } = options;\n  // For more information on how to define custom actions, see\n  //   https://backstage.io/docs/features/software-templates/writing-custom-actions\n  return createTemplateAction<{\n    repoUrl: string;\n    name: string;\n    deploymentBranchPolicy?: {\n      protected_branches: boolean;\n      custom_branch_policies: boolean;\n    };\n    customBranchPolicyNames?: string[];\n    customTagPolicyNames?: string[];\n    environmentVariables?: { [key: string]: string };\n    secrets?: { [key: string]: string };\n    token?: string;\n    waitTimer?: number;\n    preventSelfReview?: boolean;\n    reviewers?: string[];\n  }>({\n    id: 'github:environment:create',\n    description: 'Creates Deployment Environments',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'name'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          name: {\n            title: 'Environment Name',\n            description: `Name of the deployment environment to create`,\n            type: 'string',\n          },\n          deploymentBranchPolicy: {\n            title: 'Deployment Branch Policy',\n            description:\n              'The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.',\n            type: 'object',\n            required: ['protected_branches', 'custom_branch_policies'],\n            properties: {\n              protected_branches: {\n                title: 'Protected Branches',\n                description:\n                  'Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.',\n                type: 'boolean',\n              },\n              custom_branch_policies: {\n                title: 'Custom Branch Policies',\n                description:\n                  'Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.',\n                type: 'boolean',\n              },\n            },\n          },\n          customBranchPolicyNames: {\n            title: 'Custom Branch Policy Name',\n            description: `The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match \\`/\\`. For example, to match branches that begin with \\`release/\\` and contain an additional single slash, use \\`release/*/*\\`. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.`,\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          customTagPolicyNames: {\n            title: 'Custom Tag Policy Name',\n            description: `The name pattern that tags must match in order to deploy to the environment.\n\nWildcard characters will not match \\`/\\`. For example, to match tags that begin with \\`release/\\` and contain an additional single slash, use \\`release/*/*\\`. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.`,\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          environmentVariables: {\n            title: 'Environment Variables',\n            description: `Environment variables attached to the deployment environment`,\n            type: 'object',\n          },\n          secrets: {\n            title: 'Deployment Secrets',\n            description: `Secrets attached to the deployment environment`,\n            type: 'object',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n          waitTimer: {\n            title: 'Wait Timer',\n            type: 'integer',\n            description:\n              'The time to wait before creating or updating the environment (in milliseconds)',\n          },\n          preventSelfReview: {\n            title: 'Prevent Self Review',\n            type: 'boolean',\n            description: 'Whether to prevent self-review for this environment',\n          },\n          reviewers: {\n            title: 'Reviewers',\n            type: 'array',\n            description:\n              'Reviewers for this environment. Must be a list of Backstage entity references.',\n            items: {\n              type: 'string',\n            },\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        name,\n        deploymentBranchPolicy,\n        customBranchPolicyNames,\n        customTagPolicyNames,\n        environmentVariables,\n        secrets,\n        token: providedToken,\n        waitTimer,\n        preventSelfReview,\n        reviewers,\n      } = ctx.input;\n\n      const { token } = (await auth?.getPluginRequestToken({\n        onBehalfOf: await ctx.getInitiatorCredentials(),\n        targetPluginId: 'catalog',\n      })) ?? { token: ctx.secrets?.backstageToken };\n\n      // When environment creation step is executed right after a repo publish step, the repository might not be available immediately.\n      // Add a 2-second delay before initiating the steps in this action.\n      await new Promise(resolve => setTimeout(resolve, 2000));\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(`No owner provided for repo ${repoUrl}`);\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit(octokitOptions);\n      const repository = await client.rest.repos.get({\n        owner: owner,\n        repo: repo,\n      });\n\n      // convert reviewers from catalog entity to Github user or team\n      const githubReviewers: { type: 'User' | 'Team'; id: number }[] = [];\n      if (reviewers) {\n        let reviewersEntityRefs: Array<Entity | undefined> = [];\n        // Fetch reviewers from Catalog\n        const catalogResponse = await catalogClient?.getEntitiesByRefs(\n          {\n            entityRefs: reviewers,\n          },\n          {\n            token,\n          },\n        );\n        if (catalogResponse?.items?.length) {\n          reviewersEntityRefs = catalogResponse.items;\n        }\n\n        for (const reviewerEntityRef of reviewersEntityRefs) {\n          if (reviewerEntityRef?.kind === 'User') {\n            try {\n              const user = await client.rest.users.getByUsername({\n                username: reviewerEntityRef.metadata.name,\n              });\n              githubReviewers.push({\n                type: 'User',\n                id: user.data.id,\n              });\n            } catch (error) {\n              ctx.logger.error('User not found:', error);\n            }\n          } else if (reviewerEntityRef?.kind === 'Group') {\n            try {\n              const team = await client.rest.teams.getByName({\n                org: owner,\n                team_slug: reviewerEntityRef.metadata.name,\n              });\n              githubReviewers.push({\n                type: 'Team',\n                id: team.data.id,\n              });\n            } catch (error) {\n              ctx.logger.error('Team not found:', error);\n            }\n          }\n        }\n      }\n\n      await client.rest.repos.createOrUpdateEnvironment({\n        owner: owner,\n        repo: repo,\n        environment_name: name,\n        deployment_branch_policy: deploymentBranchPolicy ?? undefined,\n        wait_timer: waitTimer ?? undefined,\n        prevent_self_review: preventSelfReview ?? undefined,\n        reviewers: githubReviewers.length ? githubReviewers : undefined,\n      });\n\n      if (customBranchPolicyNames) {\n        for (const item of customBranchPolicyNames) {\n          await client.rest.repos.createDeploymentBranchPolicy({\n            owner: owner,\n            repo: repo,\n            type: 'branch',\n            environment_name: name,\n            name: item,\n          });\n        }\n      }\n\n      if (customTagPolicyNames) {\n        for (const item of customTagPolicyNames) {\n          await client.rest.repos.createDeploymentBranchPolicy({\n            owner: owner,\n            repo: repo,\n            type: 'tag',\n            environment_name: name,\n            name: item,\n          });\n        }\n      }\n\n      for (const [key, value] of Object.entries(environmentVariables ?? {})) {\n        await client.rest.actions.createEnvironmentVariable({\n          repository_id: repository.data.id,\n          owner: owner,\n          repo: repo,\n          environment_name: name,\n          name: key,\n          value,\n        });\n      }\n\n      if (secrets) {\n        const publicKeyResponse =\n          await client.rest.actions.getEnvironmentPublicKey({\n            repository_id: repository.data.id,\n            owner: owner,\n            repo: repo,\n            environment_name: name,\n          });\n\n        await Sodium.ready;\n        const binaryKey = Sodium.from_base64(\n          publicKeyResponse.data.key,\n          Sodium.base64_variants.ORIGINAL,\n        );\n        for (const [key, value] of Object.entries(secrets)) {\n          const binarySecret = Sodium.from_string(value);\n          const encryptedBinarySecret = Sodium.crypto_box_seal(\n            binarySecret,\n            binaryKey,\n          );\n          const encryptedBase64Secret = Sodium.to_base64(\n            encryptedBinarySecret,\n            Sodium.base64_variants.ORIGINAL,\n          );\n\n          await client.rest.actions.createOrUpdateEnvironmentSecret({\n            repository_id: repository.data.id,\n            owner: owner,\n            repo: repo,\n            environment_name: name,\n            secret_name: key,\n            encrypted_value: encryptedBase64Secret,\n            key_id: publicKeyResponse.data.key_id,\n          });\n        }\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","Sodium"],"mappings":";;;;;;;;;;;;;AAmCO,SAAS,8BAA8B,OAI3C,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,aAAe,EAAA,IAAA,EAAS,GAAA,OAAA;AAG9C,EAAA,OAAOA,yCAeJ,CAAA;AAAA,IACD,EAAI,EAAA,2BAAA;AAAA,IACJ,WAAa,EAAA,iCAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAA,EAAW,MAAM,CAAA;AAAA,QAC5B,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA,CAAA,4CAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,sBAAwB,EAAA;AAAA,YACtB,KAAO,EAAA,0BAAA;AAAA,YACP,WACE,EAAA,4GAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,oBAAA,EAAsB,wBAAwB,CAAA;AAAA,YACzD,UAAY,EAAA;AAAA,cACV,kBAAoB,EAAA;AAAA,gBAClB,KAAO,EAAA,oBAAA;AAAA,gBACP,WACE,EAAA,8OAAA;AAAA,gBACF,IAAM,EAAA;AAAA,eACR;AAAA,cACA,sBAAwB,EAAA;AAAA,gBACtB,KAAO,EAAA,wBAAA;AAAA,gBACP,WACE,EAAA,wPAAA;AAAA,gBACF,IAAM,EAAA;AAAA;AACR;AACF,WACF;AAAA,UACA,uBAAyB,EAAA;AAAA,YACvB,KAAO,EAAA,2BAAA;AAAA,YACP,WAAa,EAAA,CAAA;;AAAA,+PAAA,CAAA;AAAA,YAGb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,oBAAsB,EAAA;AAAA,YACpB,KAAO,EAAA,wBAAA;AAAA,YACP,WAAa,EAAA,CAAA;;AAAA,2PAAA,CAAA;AAAA,YAGb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,oBAAsB,EAAA;AAAA,YACpB,KAAO,EAAA,uBAAA;AAAA,YACP,WAAa,EAAA,CAAA,4DAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA,CAAA,8CAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,WACE,EAAA;AAAA,WACJ;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,WAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,WACE,EAAA,gFAAA;AAAA,YACF,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR;AACF;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,IAAA;AAAA,QACA,sBAAA;AAAA,QACA,uBAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,OAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,SAAA;AAAA,QACA,iBAAA;AAAA,QACA;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAI5C,MAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,GAAI,CAAC,CAAA;AAEtD,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAA8B,2BAAA,EAAA,OAAO,CAAE,CAAA,CAAA;AAAA;AAG9D,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AACzC,MAAA,MAAM,UAAa,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,GAAI,CAAA;AAAA,QAC7C,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAGD,MAAA,MAAM,kBAA2D,EAAC;AAClE,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,IAAI,sBAAiD,EAAC;AAEtD,QAAM,MAAA,eAAA,GAAkB,MAAM,aAAe,EAAA,iBAAA;AAAA,UAC3C;AAAA,YACE,UAAY,EAAA;AAAA,WACd;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AACA,QAAI,IAAA,eAAA,EAAiB,OAAO,MAAQ,EAAA;AAClC,UAAA,mBAAA,GAAsB,eAAgB,CAAA,KAAA;AAAA;AAGxC,QAAA,KAAA,MAAW,qBAAqB,mBAAqB,EAAA;AACnD,UAAI,IAAA,iBAAA,EAAmB,SAAS,MAAQ,EAAA;AACtC,YAAI,IAAA;AACF,cAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,aAAc,CAAA;AAAA,gBACjD,QAAA,EAAU,kBAAkB,QAAS,CAAA;AAAA,eACtC,CAAA;AACD,cAAA,eAAA,CAAgB,IAAK,CAAA;AAAA,gBACnB,IAAM,EAAA,MAAA;AAAA,gBACN,EAAA,EAAI,KAAK,IAAK,CAAA;AAAA,eACf,CAAA;AAAA,qBACM,KAAO,EAAA;AACd,cAAI,GAAA,CAAA,MAAA,CAAO,KAAM,CAAA,iBAAA,EAAmB,KAAK,CAAA;AAAA;AAC3C,WACF,MAAA,IAAW,iBAAmB,EAAA,IAAA,KAAS,OAAS,EAAA;AAC9C,YAAI,IAAA;AACF,cAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,SAAU,CAAA;AAAA,gBAC7C,GAAK,EAAA,KAAA;AAAA,gBACL,SAAA,EAAW,kBAAkB,QAAS,CAAA;AAAA,eACvC,CAAA;AACD,cAAA,eAAA,CAAgB,IAAK,CAAA;AAAA,gBACnB,IAAM,EAAA,MAAA;AAAA,gBACN,EAAA,EAAI,KAAK,IAAK,CAAA;AAAA,eACf,CAAA;AAAA,qBACM,KAAO,EAAA;AACd,cAAI,GAAA,CAAA,MAAA,CAAO,KAAM,CAAA,iBAAA,EAAmB,KAAK,CAAA;AAAA;AAC3C;AACF;AACF;AAGF,MAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,yBAA0B,CAAA;AAAA,QAChD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,gBAAkB,EAAA,IAAA;AAAA,QAClB,0BAA0B,sBAA0B,IAAA,KAAA,CAAA;AAAA,QACpD,YAAY,SAAa,IAAA,KAAA,CAAA;AAAA,QACzB,qBAAqB,iBAAqB,IAAA,KAAA,CAAA;AAAA,QAC1C,SAAA,EAAW,eAAgB,CAAA,MAAA,GAAS,eAAkB,GAAA,KAAA;AAAA,OACvD,CAAA;AAED,MAAA,IAAI,uBAAyB,EAAA;AAC3B,QAAA,KAAA,MAAW,QAAQ,uBAAyB,EAAA;AAC1C,UAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,4BAA6B,CAAA;AAAA,YACnD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,IAAM,EAAA,QAAA;AAAA,YACN,gBAAkB,EAAA,IAAA;AAAA,YAClB,IAAM,EAAA;AAAA,WACP,CAAA;AAAA;AACH;AAGF,MAAA,IAAI,oBAAsB,EAAA;AACxB,QAAA,KAAA,MAAW,QAAQ,oBAAsB,EAAA;AACvC,UAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,4BAA6B,CAAA;AAAA,YACnD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,IAAM,EAAA,KAAA;AAAA,YACN,gBAAkB,EAAA,IAAA;AAAA,YAClB,IAAM,EAAA;AAAA,WACP,CAAA;AAAA;AACH;AAGF,MAAW,KAAA,MAAA,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAQ,CAAA,oBAAA,IAAwB,EAAE,CAAG,EAAA;AACrE,QAAM,MAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,yBAA0B,CAAA;AAAA,UAClD,aAAA,EAAe,WAAW,IAAK,CAAA,EAAA;AAAA,UAC/B,KAAA;AAAA,UACA,IAAA;AAAA,UACA,gBAAkB,EAAA,IAAA;AAAA,UAClB,IAAM,EAAA,GAAA;AAAA,UACN;AAAA,SACD,CAAA;AAAA;AAGH,MAAA,IAAI,OAAS,EAAA;AACX,QAAA,MAAM,iBACJ,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,QAAQ,uBAAwB,CAAA;AAAA,UAChD,aAAA,EAAe,WAAW,IAAK,CAAA,EAAA;AAAA,UAC/B,KAAA;AAAA,UACA,IAAA;AAAA,UACA,gBAAkB,EAAA;AAAA,SACnB,CAAA;AAEH,QAAA,MAAMC,uBAAO,CAAA,KAAA;AACb,QAAA,MAAM,YAAYA,uBAAO,CAAA,WAAA;AAAA,UACvB,kBAAkB,IAAK,CAAA,GAAA;AAAA,UACvBA,wBAAO,eAAgB,CAAA;AAAA,SACzB;AACA,QAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAClD,UAAM,MAAA,YAAA,GAAeA,uBAAO,CAAA,WAAA,CAAY,KAAK,CAAA;AAC7C,UAAA,MAAM,wBAAwBA,uBAAO,CAAA,eAAA;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,MAAM,wBAAwBA,uBAAO,CAAA,SAAA;AAAA,YACnC,qBAAA;AAAA,YACAA,wBAAO,eAAgB,CAAA;AAAA,WACzB;AAEA,UAAM,MAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,+BAAgC,CAAA;AAAA,YACxD,aAAA,EAAe,WAAW,IAAK,CAAA,EAAA;AAAA,YAC/B,KAAA;AAAA,YACA,IAAA;AAAA,YACA,gBAAkB,EAAA,IAAA;AAAA,YAClB,WAAa,EAAA,GAAA;AAAA,YACb,eAAiB,EAAA,qBAAA;AAAA,YACjB,MAAA,EAAQ,kBAAkB,IAAK,CAAA;AAAA,WAChC,CAAA;AAAA;AACH;AACF;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubEnvironment.cjs.js","sources":["../../src/actions/githubEnvironment.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { getOctokitOptions } from '../util';\nimport { Octokit } from 'octokit';\nimport Sodium from 'libsodium-wrappers';\nimport { examples } from './gitHubEnvironment.examples';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport { Entity } from '@backstage/catalog-model';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\n/**\n * Creates an `github:environment:create` Scaffolder action that creates a Github Environment.\n *\n * @public\n */\nexport function createGithubEnvironmentAction(options: {\n  integrations: ScmIntegrationRegistry;\n  catalogClient?: CatalogApi;\n  auth?: AuthService;\n}) {\n  const { integrations, catalogClient, auth } = options;\n  // For more information on how to define custom actions, see\n  //   https://backstage.io/docs/features/software-templates/writing-custom-actions\n  return createTemplateAction<{\n    repoUrl: string;\n    name: string;\n    deploymentBranchPolicy?: {\n      protected_branches: boolean;\n      custom_branch_policies: boolean;\n    };\n    customBranchPolicyNames?: string[];\n    customTagPolicyNames?: string[];\n    environmentVariables?: { [key: string]: string };\n    secrets?: { [key: string]: string };\n    token?: string;\n    waitTimer?: number;\n    preventSelfReview?: boolean;\n    reviewers?: string[];\n  }>({\n    id: 'github:environment:create',\n    description: 'Creates Deployment Environments',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'name'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          name: {\n            title: 'Environment Name',\n            description: `Name of the deployment environment to create`,\n            type: 'string',\n          },\n          deploymentBranchPolicy: {\n            title: 'Deployment Branch Policy',\n            description:\n              'The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.',\n            type: 'object',\n            required: ['protected_branches', 'custom_branch_policies'],\n            properties: {\n              protected_branches: {\n                title: 'Protected Branches',\n                description:\n                  'Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.',\n                type: 'boolean',\n              },\n              custom_branch_policies: {\n                title: 'Custom Branch Policies',\n                description:\n                  'Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.',\n                type: 'boolean',\n              },\n            },\n          },\n          customBranchPolicyNames: {\n            title: 'Custom Branch Policy Name',\n            description: `The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match \\`/\\`. For example, to match branches that begin with \\`release/\\` and contain an additional single slash, use \\`release/*/*\\`. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.`,\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          customTagPolicyNames: {\n            title: 'Custom Tag Policy Name',\n            description: `The name pattern that tags must match in order to deploy to the environment.\n\nWildcard characters will not match \\`/\\`. For example, to match tags that begin with \\`release/\\` and contain an additional single slash, use \\`release/*/*\\`. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.`,\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          environmentVariables: {\n            title: 'Environment Variables',\n            description: `Environment variables attached to the deployment environment`,\n            type: 'object',\n          },\n          secrets: {\n            title: 'Deployment Secrets',\n            description: `Secrets attached to the deployment environment`,\n            type: 'object',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n          waitTimer: {\n            title: 'Wait Timer',\n            type: 'integer',\n            description:\n              'The time to wait before creating or updating the environment (in milliseconds)',\n          },\n          preventSelfReview: {\n            title: 'Prevent Self Review',\n            type: 'boolean',\n            description: 'Whether to prevent self-review for this environment',\n          },\n          reviewers: {\n            title: 'Reviewers',\n            type: 'array',\n            description:\n              'Reviewers for this environment. Must be a list of Backstage entity references.',\n            items: {\n              type: 'string',\n            },\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        name,\n        deploymentBranchPolicy,\n        customBranchPolicyNames,\n        customTagPolicyNames,\n        environmentVariables,\n        secrets,\n        token: providedToken,\n        waitTimer,\n        preventSelfReview,\n        reviewers,\n      } = ctx.input;\n\n      const { token } = (await auth?.getPluginRequestToken({\n        onBehalfOf: await ctx.getInitiatorCredentials(),\n        targetPluginId: 'catalog',\n      })) ?? { token: ctx.secrets?.backstageToken };\n\n      // When environment creation step is executed right after a repo publish step, the repository might not be available immediately.\n      // Add a 2-second delay before initiating the steps in this action.\n      await new Promise(resolve => setTimeout(resolve, 2000));\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(`No owner provided for repo ${repoUrl}`);\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit(octokitOptions);\n\n      const repositoryId = await ctx.checkpoint({\n        key: `get.repo.${owner}.${repo}`,\n        fn: async () => {\n          const repository = await client.rest.repos.get({\n            owner: owner,\n            repo: repo,\n          });\n          return repository.data.id;\n        },\n      });\n\n      // convert reviewers from catalog entity to Github user or team\n      const githubReviewers: { type: 'User' | 'Team'; id: number }[] = [];\n      if (reviewers) {\n        let reviewersEntityRefs: Array<Entity | undefined> = [];\n        // Fetch reviewers from Catalog\n        const catalogResponse = await catalogClient?.getEntitiesByRefs(\n          {\n            entityRefs: reviewers,\n          },\n          {\n            token,\n          },\n        );\n        if (catalogResponse?.items?.length) {\n          reviewersEntityRefs = catalogResponse.items;\n        }\n\n        for (const reviewerEntityRef of reviewersEntityRefs) {\n          if (reviewerEntityRef?.kind === 'User') {\n            try {\n              const userId = await ctx.checkpoint({\n                key: `get.user.${reviewerEntityRef.metadata.name}`,\n                fn: async () => {\n                  const user = await client.rest.users.getByUsername({\n                    username: reviewerEntityRef.metadata.name,\n                  });\n                  return user.data.id;\n                },\n              });\n\n              githubReviewers.push({\n                type: 'User',\n                id: userId,\n              });\n            } catch (error) {\n              ctx.logger.error('User not found:', error);\n            }\n          } else if (reviewerEntityRef?.kind === 'Group') {\n            try {\n              const teamId = await ctx.checkpoint({\n                key: `get.team.${reviewerEntityRef.metadata.name}`,\n                fn: async () => {\n                  const team = await client.rest.teams.getByName({\n                    org: owner,\n                    team_slug: reviewerEntityRef.metadata.name,\n                  });\n                  return team.data.id;\n                },\n              });\n\n              githubReviewers.push({\n                type: 'Team',\n                id: teamId,\n              });\n            } catch (error) {\n              ctx.logger.error('Team not found:', error);\n            }\n          }\n        }\n      }\n\n      await ctx.checkpoint({\n        key: `create.or.update.environment.${owner}.${repo}.${name}`,\n        fn: async () => {\n          await client.rest.repos.createOrUpdateEnvironment({\n            owner: owner,\n            repo: repo,\n            environment_name: name,\n            deployment_branch_policy: deploymentBranchPolicy ?? undefined,\n            wait_timer: waitTimer ?? undefined,\n            prevent_self_review: preventSelfReview ?? undefined,\n            reviewers: githubReviewers.length ? githubReviewers : undefined,\n          });\n        },\n      });\n\n      if (customBranchPolicyNames) {\n        for (const item of customBranchPolicyNames) {\n          await ctx.checkpoint({\n            key: `create.deployment.branch.policy.branch.${owner}.${repo}.${name}.${item}`,\n            fn: async () => {\n              await client.rest.repos.createDeploymentBranchPolicy({\n                owner: owner,\n                repo: repo,\n                type: 'branch',\n                environment_name: name,\n                name: item,\n              });\n            },\n          });\n        }\n      }\n\n      if (customTagPolicyNames) {\n        for (const item of customTagPolicyNames) {\n          await ctx.checkpoint({\n            key: `create.deployment.branch.policy.tag.${owner}.${repo}.${name}.${item}`,\n            fn: async () => {\n              await client.rest.repos.createDeploymentBranchPolicy({\n                owner: owner,\n                repo: repo,\n                type: 'tag',\n                environment_name: name,\n                name: item,\n              });\n            },\n          });\n        }\n      }\n\n      for (const [key, value] of Object.entries(environmentVariables ?? {})) {\n        await ctx.checkpoint({\n          key: `create.env.variable.${owner}.${repo}.${name}.${key}`,\n          fn: async () => {\n            await client.rest.actions.createEnvironmentVariable({\n              repository_id: repositoryId,\n              owner: owner,\n              repo: repo,\n              environment_name: name,\n              name: key,\n              value,\n            });\n          },\n        });\n      }\n\n      if (secrets) {\n        const { publicKey, publicKeyId } = await ctx.checkpoint({\n          key: `get.env.public.key.${owner}.${repo}.${name}`,\n          fn: async () => {\n            const publicKeyResponse =\n              await client.rest.actions.getEnvironmentPublicKey({\n                repository_id: repositoryId,\n                owner: owner,\n                repo: repo,\n                environment_name: name,\n              });\n            return {\n              publicKey: publicKeyResponse.data.key,\n              publicKeyId: publicKeyResponse.data.key_id,\n            };\n          },\n        });\n\n        await Sodium.ready;\n        const binaryKey = Sodium.from_base64(\n          publicKey,\n          Sodium.base64_variants.ORIGINAL,\n        );\n        for (const [key, value] of Object.entries(secrets)) {\n          const binarySecret = Sodium.from_string(value);\n          const encryptedBinarySecret = Sodium.crypto_box_seal(\n            binarySecret,\n            binaryKey,\n          );\n          const encryptedBase64Secret = Sodium.to_base64(\n            encryptedBinarySecret,\n            Sodium.base64_variants.ORIGINAL,\n          );\n\n          await ctx.checkpoint({\n            key: `create.or.update.env.secret.${owner}.${repo}.${name}.${key}`,\n            fn: async () => {\n              await client.rest.actions.createOrUpdateEnvironmentSecret({\n                repository_id: repositoryId,\n                owner: owner,\n                repo: repo,\n                environment_name: name,\n                secret_name: key,\n                encrypted_value: encryptedBase64Secret,\n                key_id: publicKeyId,\n              });\n            },\n          });\n        }\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","Sodium"],"mappings":";;;;;;;;;;;;;AAmCO,SAAS,8BAA8B,OAI3C,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,aAAe,EAAA,IAAA,EAAS,GAAA,OAAA;AAG9C,EAAA,OAAOA,yCAeJ,CAAA;AAAA,IACD,EAAI,EAAA,2BAAA;AAAA,IACJ,WAAa,EAAA,iCAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAA,EAAW,MAAM,CAAA;AAAA,QAC5B,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA,CAAA,4CAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,sBAAwB,EAAA;AAAA,YACtB,KAAO,EAAA,0BAAA;AAAA,YACP,WACE,EAAA,4GAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,oBAAA,EAAsB,wBAAwB,CAAA;AAAA,YACzD,UAAY,EAAA;AAAA,cACV,kBAAoB,EAAA;AAAA,gBAClB,KAAO,EAAA,oBAAA;AAAA,gBACP,WACE,EAAA,8OAAA;AAAA,gBACF,IAAM,EAAA;AAAA,eACR;AAAA,cACA,sBAAwB,EAAA;AAAA,gBACtB,KAAO,EAAA,wBAAA;AAAA,gBACP,WACE,EAAA,wPAAA;AAAA,gBACF,IAAM,EAAA;AAAA;AACR;AACF,WACF;AAAA,UACA,uBAAyB,EAAA;AAAA,YACvB,KAAO,EAAA,2BAAA;AAAA,YACP,WAAa,EAAA,CAAA;;AAAA,+PAAA,CAAA;AAAA,YAGb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,oBAAsB,EAAA;AAAA,YACpB,KAAO,EAAA,wBAAA;AAAA,YACP,WAAa,EAAA,CAAA;;AAAA,2PAAA,CAAA;AAAA,YAGb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,oBAAsB,EAAA;AAAA,YACpB,KAAO,EAAA,uBAAA;AAAA,YACP,WAAa,EAAA,CAAA,4DAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA,CAAA,8CAAA,CAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,WACE,EAAA;AAAA,WACJ;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,WAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,WACE,EAAA,gFAAA;AAAA,YACF,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR;AACF;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,IAAA;AAAA,QACA,sBAAA;AAAA,QACA,uBAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,OAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,SAAA;AAAA,QACA,iBAAA;AAAA,QACA;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAI5C,MAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,GAAI,CAAC,CAAA;AAEtD,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAA8B,2BAAA,EAAA,OAAO,CAAE,CAAA,CAAA;AAAA;AAG9D,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAM,MAAA,YAAA,GAAe,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,QACxC,GAAK,EAAA,CAAA,SAAA,EAAY,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC9B,IAAI,YAAY;AACd,UAAA,MAAM,UAAa,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,GAAI,CAAA;AAAA,YAC7C,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO,WAAW,IAAK,CAAA,EAAA;AAAA;AACzB,OACD,CAAA;AAGD,MAAA,MAAM,kBAA2D,EAAC;AAClE,MAAA,IAAI,SAAW,EAAA;AACb,QAAA,IAAI,sBAAiD,EAAC;AAEtD,QAAM,MAAA,eAAA,GAAkB,MAAM,aAAe,EAAA,iBAAA;AAAA,UAC3C;AAAA,YACE,UAAY,EAAA;AAAA,WACd;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AACA,QAAI,IAAA,eAAA,EAAiB,OAAO,MAAQ,EAAA;AAClC,UAAA,mBAAA,GAAsB,eAAgB,CAAA,KAAA;AAAA;AAGxC,QAAA,KAAA,MAAW,qBAAqB,mBAAqB,EAAA;AACnD,UAAI,IAAA,iBAAA,EAAmB,SAAS,MAAQ,EAAA;AACtC,YAAI,IAAA;AACF,cAAM,MAAA,MAAA,GAAS,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,gBAClC,GAAK,EAAA,CAAA,SAAA,EAAY,iBAAkB,CAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,aAAc,CAAA;AAAA,oBACjD,QAAA,EAAU,kBAAkB,QAAS,CAAA;AAAA,mBACtC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAK,CAAA,EAAA;AAAA;AACnB,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAK,CAAA;AAAA,gBACnB,IAAM,EAAA,MAAA;AAAA,gBACN,EAAI,EAAA;AAAA,eACL,CAAA;AAAA,qBACM,KAAO,EAAA;AACd,cAAI,GAAA,CAAA,MAAA,CAAO,KAAM,CAAA,iBAAA,EAAmB,KAAK,CAAA;AAAA;AAC3C,WACF,MAAA,IAAW,iBAAmB,EAAA,IAAA,KAAS,OAAS,EAAA;AAC9C,YAAI,IAAA;AACF,cAAM,MAAA,MAAA,GAAS,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,gBAClC,GAAK,EAAA,CAAA,SAAA,EAAY,iBAAkB,CAAA,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,SAAU,CAAA;AAAA,oBAC7C,GAAK,EAAA,KAAA;AAAA,oBACL,SAAA,EAAW,kBAAkB,QAAS,CAAA;AAAA,mBACvC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAK,CAAA,EAAA;AAAA;AACnB,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAK,CAAA;AAAA,gBACnB,IAAM,EAAA,MAAA;AAAA,gBACN,EAAI,EAAA;AAAA,eACL,CAAA;AAAA,qBACM,KAAO,EAAA;AACd,cAAI,GAAA,CAAA,MAAA,CAAO,KAAM,CAAA,iBAAA,EAAmB,KAAK,CAAA;AAAA;AAC3C;AACF;AACF;AAGF,MAAA,MAAM,IAAI,UAAW,CAAA;AAAA,QACnB,KAAK,CAAgC,6BAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,yBAA0B,CAAA;AAAA,YAChD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,gBAAkB,EAAA,IAAA;AAAA,YAClB,0BAA0B,sBAA0B,IAAA,KAAA,CAAA;AAAA,YACpD,YAAY,SAAa,IAAA,KAAA,CAAA;AAAA,YACzB,qBAAqB,iBAAqB,IAAA,KAAA,CAAA;AAAA,YAC1C,SAAA,EAAW,eAAgB,CAAA,MAAA,GAAS,eAAkB,GAAA,KAAA;AAAA,WACvD,CAAA;AAAA;AACH,OACD,CAAA;AAED,MAAA,IAAI,uBAAyB,EAAA;AAC3B,QAAA,KAAA,MAAW,QAAQ,uBAAyB,EAAA;AAC1C,UAAA,MAAM,IAAI,UAAW,CAAA;AAAA,YACnB,GAAA,EAAK,0CAA0C,KAAK,CAAA,CAAA,EAAI,IAAI,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YAC5E,IAAI,YAAY;AACd,cAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,4BAA6B,CAAA;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAM,EAAA,QAAA;AAAA,gBACN,gBAAkB,EAAA,IAAA;AAAA,gBAClB,IAAM,EAAA;AAAA,eACP,CAAA;AAAA;AACH,WACD,CAAA;AAAA;AACH;AAGF,MAAA,IAAI,oBAAsB,EAAA;AACxB,QAAA,KAAA,MAAW,QAAQ,oBAAsB,EAAA;AACvC,UAAA,MAAM,IAAI,UAAW,CAAA;AAAA,YACnB,GAAA,EAAK,uCAAuC,KAAK,CAAA,CAAA,EAAI,IAAI,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YACzE,IAAI,YAAY;AACd,cAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,4BAA6B,CAAA;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAM,EAAA,KAAA;AAAA,gBACN,gBAAkB,EAAA,IAAA;AAAA,gBAClB,IAAM,EAAA;AAAA,eACP,CAAA;AAAA;AACH,WACD,CAAA;AAAA;AACH;AAGF,MAAW,KAAA,MAAA,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAQ,CAAA,oBAAA,IAAwB,EAAE,CAAG,EAAA;AACrE,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,GAAA,EAAK,uBAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAI,CAAA,EAAA,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,UACxD,IAAI,YAAY;AACd,YAAM,MAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,yBAA0B,CAAA;AAAA,cAClD,aAAe,EAAA,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAkB,EAAA,IAAA;AAAA,cAClB,IAAM,EAAA,GAAA;AAAA,cACN;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAAA;AAGH,MAAA,IAAI,OAAS,EAAA;AACX,QAAA,MAAM,EAAE,SAAW,EAAA,WAAA,EAAgB,GAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACtD,KAAK,CAAsB,mBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,UAChD,IAAI,YAAY;AACd,YAAA,MAAM,iBACJ,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,QAAQ,uBAAwB,CAAA;AAAA,cAChD,aAAe,EAAA,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAkB,EAAA;AAAA,aACnB,CAAA;AACH,YAAO,OAAA;AAAA,cACL,SAAA,EAAW,kBAAkB,IAAK,CAAA,GAAA;AAAA,cAClC,WAAA,EAAa,kBAAkB,IAAK,CAAA;AAAA,aACtC;AAAA;AACF,SACD,CAAA;AAED,QAAA,MAAMC,uBAAO,CAAA,KAAA;AACb,QAAA,MAAM,YAAYA,uBAAO,CAAA,WAAA;AAAA,UACvB,SAAA;AAAA,UACAA,wBAAO,eAAgB,CAAA;AAAA,SACzB;AACA,QAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AAClD,UAAM,MAAA,YAAA,GAAeA,uBAAO,CAAA,WAAA,CAAY,KAAK,CAAA;AAC7C,UAAA,MAAM,wBAAwBA,uBAAO,CAAA,eAAA;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,MAAM,wBAAwBA,uBAAO,CAAA,SAAA;AAAA,YACnC,qBAAA;AAAA,YACAA,wBAAO,eAAgB,CAAA;AAAA,WACzB;AAEA,UAAA,MAAM,IAAI,UAAW,CAAA;AAAA,YACnB,GAAA,EAAK,+BAA+B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAI,CAAA,EAAA,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,YAChE,IAAI,YAAY;AACd,cAAM,MAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,+BAAgC,CAAA;AAAA,gBACxD,aAAe,EAAA,YAAA;AAAA,gBACf,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,gBAAkB,EAAA,IAAA;AAAA,gBAClB,WAAa,EAAA,GAAA;AAAA,gBACb,eAAiB,EAAA,qBAAA;AAAA,gBACjB,MAAQ,EAAA;AAAA,eACT,CAAA;AAAA;AACH,WACD,CAAA;AAAA;AACH;AACF;AACF,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubIssuesLabel.cjs.js

@@ -61,11 +61,16 @@ function createGithubIssuesLabelAction(options) {
         })
       );
       try {
-        await client.rest.issues.addLabels({
-          owner,
-          repo,
-          issue_number: number,
-          labels
+        await ctx.checkpoint({
+          key: `github.issues.add.label.${owner}.${repo}.${number}`,
+          fn: async () => {
+            await client.rest.issues.addLabels({
+              owner,
+              repo,
+              issue_number: number,
+              labels
+            });
+          }
         });
       } catch (e) {
         errors.assertError(e);

package/dist/actions/githubIssuesLabel.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubIssuesLabel.cjs.js","sources":["../../src/actions/githubIssuesLabel.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubIssuesLabel.examples';\n\n/**\n * Adds labels to a pull request or issue on GitHub\n * @public\n */\nexport function createGithubIssuesLabelAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    number: number;\n    labels: string[];\n    token?: string;\n  }>({\n    id: 'github:issues:label',\n    description: 'Adds labels to a pull request or issue on GitHub.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'number', 'labels'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          number: {\n            title: 'Pull Request or issue number',\n            description: 'The pull request or issue number to add labels to',\n            type: 'number',\n          },\n          labels: {\n            title: 'Labels',\n            description: 'The labels to add to the pull request or issue',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description:\n              'The `GITHUB_TOKEN` to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { repoUrl, number, labels, token: providedToken } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n      ctx.logger.info(`Adding labels to ${number} issue on repo ${repo}`);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          credentialsProvider: githubCredentialsProvider,\n          host,\n          owner,\n          repo,\n          token: providedToken,\n        }),\n      );\n\n      try {\n        await client.rest.issues.addLabels({\n          owner,\n          repo,\n          issue_number: number,\n          labels,\n        });\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: adding labels to issue: '${number}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions","assertError"],"mappings":";;;;;;;;AAiCO,SAAS,8BAA8B,OAG3C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCAKJ,CAAA;AAAA,IACD,EAAI,EAAA,qBAAA;AAAA,IACJ,WAAa,EAAA,mDAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAU,EAAA,CAAC,SAAW,EAAA,QAAA,EAAU,QAAQ,CAAA;AAAA,QACxC,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,8IAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,8BAAA;AAAA,YACP,WAAa,EAAA,mDAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,WAAa,EAAA,gDAAA;AAAA,YACb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,OAAS,EAAA,MAAA,EAAQ,QAAQ,KAAO,EAAA,aAAA,KAAkB,GAAI,CAAA,KAAA;AAE9D,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAE,CAAA,CAAA;AAElE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,sBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,IAAA;AAAA,UACA,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAO,EAAA;AAAA,SACR;AAAA,OACH;AAEA,MAAI,IAAA;AACF,QAAM,MAAA,MAAA,CAAO,IAAK,CAAA,MAAA,CAAO,SAAU,CAAA;AAAA,UACjC,KAAA;AAAA,UACA,IAAA;AAAA,UACA,YAAc,EAAA,MAAA;AAAA,UACd;AAAA,SACD,CAAA;AAAA,eACM,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,oCAAoC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SAC9E;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubIssuesLabel.cjs.js","sources":["../../src/actions/githubIssuesLabel.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubIssuesLabel.examples';\n\n/**\n * Adds labels to a pull request or issue on GitHub\n * @public\n */\nexport function createGithubIssuesLabelAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    number: number;\n    labels: string[];\n    token?: string;\n  }>({\n    id: 'github:issues:label',\n    description: 'Adds labels to a pull request or issue on GitHub.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'number', 'labels'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          number: {\n            title: 'Pull Request or issue number',\n            description: 'The pull request or issue number to add labels to',\n            type: 'number',\n          },\n          labels: {\n            title: 'Labels',\n            description: 'The labels to add to the pull request or issue',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description:\n              'The `GITHUB_TOKEN` to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { repoUrl, number, labels, token: providedToken } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n      ctx.logger.info(`Adding labels to ${number} issue on repo ${repo}`);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          credentialsProvider: githubCredentialsProvider,\n          host,\n          owner,\n          repo,\n          token: providedToken,\n        }),\n      );\n\n      try {\n        await ctx.checkpoint({\n          key: `github.issues.add.label.${owner}.${repo}.${number}`,\n          fn: async () => {\n            await client.rest.issues.addLabels({\n              owner,\n              repo,\n              issue_number: number,\n              labels,\n            });\n          },\n        });\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: adding labels to issue: '${number}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions","assertError"],"mappings":";;;;;;;;AAiCO,SAAS,8BAA8B,OAG3C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCAKJ,CAAA;AAAA,IACD,EAAI,EAAA,qBAAA;AAAA,IACJ,WAAa,EAAA,mDAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAU,EAAA,CAAC,SAAW,EAAA,QAAA,EAAU,QAAQ,CAAA;AAAA,QACxC,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,8IAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,8BAAA;AAAA,YACP,WAAa,EAAA,mDAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,WAAa,EAAA,gDAAA;AAAA,YACb,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA;AACR,WACF;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,OAAS,EAAA,MAAA,EAAQ,QAAQ,KAAO,EAAA,aAAA,KAAkB,GAAI,CAAA,KAAA;AAE9D,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAE,CAAA,CAAA;AAElE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,sBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,IAAA;AAAA,UACA,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAO,EAAA;AAAA,SACR;AAAA,OACH;AAEA,MAAI,IAAA;AACF,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,KAAK,CAA2B,wBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,MAAM,CAAA,CAAA;AAAA,UACvD,IAAI,YAAY;AACd,YAAM,MAAA,MAAA,CAAO,IAAK,CAAA,MAAA,CAAO,SAAU,CAAA;AAAA,cACjC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,YAAc,EAAA,MAAA;AAAA,cACd;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAAA,eACM,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,oCAAoC,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SAC9E;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubPagesEnable.cjs.js

@@ -74,16 +74,21 @@ function createGithubPagesEnableAction(options) {
       ctx.logger.info(
         `Attempting to enable GitHub Pages for ${owner}/${repo} with "${buildType}" build type, on source branch "${sourceBranch}" and source path "${sourcePath}"`
       );
-      await client.request("POST /repos/{owner}/{repo}/pages", {
-        owner,
-        repo,
-        build_type: buildType,
-        source: {
-          branch: sourceBranch,
-          path: sourcePath
-        },
-        headers: {
-          "X-GitHub-Api-Version": "2022-11-28"
+      await ctx.checkpoint({
+        key: `enabled.github.pages.${owner}.${repo}`,
+        fn: async () => {
+          await client.request("POST /repos/{owner}/{repo}/pages", {
+            owner,
+            repo,
+            build_type: buildType,
+            source: {
+              branch: sourceBranch,
+              path: sourcePath
+            },
+            headers: {
+              "X-GitHub-Api-Version": "2022-11-28"
+            }
+          });
         }
       });
       ctx.logger.info("Completed enabling GitHub Pages");

package/dist/actions/githubPagesEnable.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubPagesEnable.cjs.js","sources":["../../src/actions/githubPagesEnable.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './githubPagesEnable.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Creates a new action that enables GitHub Pages for a repository.\n *\n * @public\n */\nexport function createGithubPagesEnableAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    buildType?: 'legacy' | 'workflow';\n    sourceBranch?: string;\n    sourcePath?: '/' | '/docs';\n    token?: string;\n  }>({\n    id: 'github:pages:enable',\n    examples,\n    description: 'Enables GitHub Pages for a repository.',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          buildType: {\n            title: 'Build Type',\n            type: 'string',\n            default: 'workflow',\n            description:\n              'The GitHub Pages build type - `legacy` or `workflow`. Default is `workflow`',\n            enum: ['legacy', 'workflow'],\n          },\n          sourceBranch: {\n            title: 'Source Branch',\n            type: 'string',\n            default: 'main',\n            description: 'The GitHub Pages source branch. Default is \"main\"',\n          },\n          sourcePath: {\n            title: 'Source Path',\n            type: 'string',\n            default: '/',\n            description:\n              'The GitHub Pages source path - \"/\" or \"/docs\". Default is \"/\"',\n            enum: ['/', '/docs'],\n          },\n          token: {\n            title: 'Authorization Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        buildType = 'workflow',\n        sourceBranch = 'main',\n        sourcePath = '/',\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit(octokitOptions);\n\n      ctx.logger.info(\n        `Attempting to enable GitHub Pages for ${owner}/${repo} with \"${buildType}\" build type, on source branch \"${sourceBranch}\" and source path \"${sourcePath}\"`,\n      );\n\n      await client.request('POST /repos/{owner}/{repo}/pages', {\n        owner: owner,\n        repo: repo,\n        build_type: buildType,\n        source: {\n          branch: sourceBranch,\n          path: sourcePath,\n        },\n        headers: {\n          'X-GitHub-Api-Version': '2022-11-28',\n        },\n      });\n\n      ctx.logger.info('Completed enabling GitHub Pages');\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAkCO,SAAS,8BAA8B,OAG3C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCAMJ,CAAA;AAAA,IACD,EAAI,EAAA,qBAAA;AAAA,cACJC,mCAAA;AAAA,IACA,WAAa,EAAA,wCAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,UAAA;AAAA,YACT,WACE,EAAA,6EAAA;AAAA,YACF,IAAA,EAAM,CAAC,QAAA,EAAU,UAAU;AAAA,WAC7B;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,eAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,MAAA;AAAA,YACT,WAAa,EAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,GAAA;AAAA,YACT,WACE,EAAA,+DAAA;AAAA,YACF,IAAA,EAAM,CAAC,GAAA,EAAK,OAAO;AAAA,WACrB;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA;AACf;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,SAAY,GAAA,UAAA;AAAA,QACZ,YAAe,GAAA,MAAA;AAAA,QACf,UAAa,GAAA,GAAA;AAAA,QACb,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,sCAAA,EAAyC,KAAK,CAAI,CAAA,EAAA,IAAI,UAAU,SAAS,CAAA,gCAAA,EAAmC,YAAY,CAAA,mBAAA,EAAsB,UAAU,CAAA,CAAA;AAAA,OAC1J;AAEA,MAAM,MAAA,MAAA,CAAO,QAAQ,kCAAoC,EAAA;AAAA,QACvD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,UAAY,EAAA,SAAA;AAAA,QACZ,MAAQ,EAAA;AAAA,UACN,MAAQ,EAAA,YAAA;AAAA,UACR,IAAM,EAAA;AAAA,SACR;AAAA,QACA,OAAS,EAAA;AAAA,UACP,sBAAwB,EAAA;AAAA;AAC1B,OACD,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,iCAAiC,CAAA;AAAA;AACnD,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubPagesEnable.cjs.js","sources":["../../src/actions/githubPagesEnable.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './githubPagesEnable.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Creates a new action that enables GitHub Pages for a repository.\n *\n * @public\n */\nexport function createGithubPagesEnableAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    buildType?: 'legacy' | 'workflow';\n    sourceBranch?: string;\n    sourcePath?: '/' | '/docs';\n    token?: string;\n  }>({\n    id: 'github:pages:enable',\n    examples,\n    description: 'Enables GitHub Pages for a repository.',\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          buildType: {\n            title: 'Build Type',\n            type: 'string',\n            default: 'workflow',\n            description:\n              'The GitHub Pages build type - `legacy` or `workflow`. Default is `workflow`',\n            enum: ['legacy', 'workflow'],\n          },\n          sourceBranch: {\n            title: 'Source Branch',\n            type: 'string',\n            default: 'main',\n            description: 'The GitHub Pages source branch. Default is \"main\"',\n          },\n          sourcePath: {\n            title: 'Source Path',\n            type: 'string',\n            default: '/',\n            description:\n              'The GitHub Pages source path - \"/\" or \"/docs\". Default is \"/\"',\n            enum: ['/', '/docs'],\n          },\n          token: {\n            title: 'Authorization Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        buildType = 'workflow',\n        sourceBranch = 'main',\n        sourcePath = '/',\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit(octokitOptions);\n\n      ctx.logger.info(\n        `Attempting to enable GitHub Pages for ${owner}/${repo} with \"${buildType}\" build type, on source branch \"${sourceBranch}\" and source path \"${sourcePath}\"`,\n      );\n\n      await ctx.checkpoint({\n        key: `enabled.github.pages.${owner}.${repo}`,\n        fn: async () => {\n          await client.request('POST /repos/{owner}/{repo}/pages', {\n            owner: owner,\n            repo: repo,\n            build_type: buildType,\n            source: {\n              branch: sourceBranch,\n              path: sourcePath,\n            },\n            headers: {\n              'X-GitHub-Api-Version': '2022-11-28',\n            },\n          });\n        },\n      });\n\n      ctx.logger.info('Completed enabling GitHub Pages');\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAkCO,SAAS,8BAA8B,OAG3C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCAMJ,CAAA;AAAA,IACD,EAAI,EAAA,qBAAA;AAAA,cACJC,mCAAA;AAAA,IACA,WAAa,EAAA,wCAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,UAAA;AAAA,YACT,WACE,EAAA,6EAAA;AAAA,YACF,IAAA,EAAM,CAAC,QAAA,EAAU,UAAU;AAAA,WAC7B;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,eAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,MAAA;AAAA,YACT,WAAa,EAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,OAAS,EAAA,GAAA;AAAA,YACT,WACE,EAAA,+DAAA;AAAA,YACF,IAAA,EAAM,CAAC,GAAA,EAAK,OAAO;AAAA,WACrB;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA;AACf;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,SAAY,GAAA,UAAA;AAAA,QACZ,YAAe,GAAA,MAAA;AAAA,QACf,UAAa,GAAA,GAAA;AAAA,QACb,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAA,sCAAA,EAAyC,KAAK,CAAI,CAAA,EAAA,IAAI,UAAU,SAAS,CAAA,gCAAA,EAAmC,YAAY,CAAA,mBAAA,EAAsB,UAAU,CAAA,CAAA;AAAA,OAC1J;AAEA,MAAA,MAAM,IAAI,UAAW,CAAA;AAAA,QACnB,GAAK,EAAA,CAAA,qBAAA,EAAwB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC1C,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,CAAO,QAAQ,kCAAoC,EAAA;AAAA,YACvD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,UAAY,EAAA,SAAA;AAAA,YACZ,MAAQ,EAAA;AAAA,cACN,MAAQ,EAAA,YAAA;AAAA,cACR,IAAM,EAAA;AAAA,aACR;AAAA,YACA,OAAS,EAAA;AAAA,cACP,sBAAwB,EAAA;AAAA;AAC1B,WACD,CAAA;AAAA;AACH,OACD,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,iCAAiC,CAAA;AAAA;AACnD,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubPullRequest.cjs.js

@@ -290,15 +290,28 @@ const createPublishGithubPullRequestAction = (options) => {
         if (targetBranchName) {
           createOptions.base = targetBranchName;
         }
-        const response = await client.createPullRequest(createOptions);
-        if (createWhenEmpty === false && !response) {
+        const pr = await ctx.checkpoint({
+          key: `create.pr.${owner}.${repo}.${branchName}`,
+          fn: async () => {
+            const response = await client.createPullRequest(createOptions);
+            if (!response) {
+              return null;
+            }
+            return {
+              base: response?.data.base,
+              html_url: response?.data.html_url,
+              number: response?.data.number
+            };
+          }
+        });
+        if (createWhenEmpty === false && !pr) {
           ctx.logger.info("No changes to commit, pull request was not created");
           return;
         }
-        if (!response) {
+        if (!pr) {
           throw new GithubResponseError("null response from Github");
         }
-        const pullRequestNumber = response.data.number;
+        const pullRequestNumber = pr.number;
         if (reviewers || teamReviewers) {
           const pullRequest = { owner, repo, number: pullRequestNumber };
           await requestReviewersOnPullRequest(
@@ -306,32 +319,38 @@ const createPublishGithubPullRequestAction = (options) => {
             reviewers,
             teamReviewers,
             client,
-            ctx.logger
+            ctx.logger,
+            ctx.checkpoint
           );
         }
-        const targetBranch = response.data.base.ref;
+        const targetBranch = pr.base.ref;
         ctx.output("targetBranchName", targetBranch);
-        ctx.output("remoteUrl", response.data.html_url);
+        ctx.output("remoteUrl", pr.html_url);
         ctx.output("pullRequestNumber", pullRequestNumber);
       } catch (e) {
         throw new GithubResponseError("Pull request creation failed", e);
       }
     }
   });
-  async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger) {
+  async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger, checkpoint) {
     try {
-      const result = await client.rest.pulls.requestReviewers({
-        owner: pr.owner,
-        repo: pr.repo,
-        pull_number: pr.number,
-        reviewers,
-        team_reviewers: teamReviewers ? [...new Set(teamReviewers)] : void 0
+      await checkpoint({
+        key: `request.reviewers.${pr.owner}.${pr.repo}.${pr.number}`,
+        fn: async () => {
+          const result = await client.rest.pulls.requestReviewers({
+            owner: pr.owner,
+            repo: pr.repo,
+            pull_number: pr.number,
+            reviewers,
+            team_reviewers: teamReviewers ? [...new Set(teamReviewers)] : void 0
+          });
+          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}`
+          );
+        }
       });
-      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}`
-      );
     } catch (e) {
       logger.error(
         `Failure when adding reviewers to Pull request ${pr.number}`,

package/dist/actions/githubPullRequest.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubPullRequest.cjs.js","sources":["../../src/actions/githubPullRequest.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport path from 'path';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  SerializedFile,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { CustomErrorBase, InputError } from '@backstage/errors';\nimport { createPullRequest } from 'octokit-plugin-create-pull-request';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubPullRequest.examples';\nimport {\n  LoggerService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\n\nexport type Encoding = 'utf-8' | 'base64';\n\nclass GithubResponseError extends CustomErrorBase {}\n\nexport const defaultClientFactory: CreateGithubPullRequestActionOptions['clientFactory'] =\n  async ({\n    integrations,\n    githubCredentialsProvider,\n    owner,\n    repo,\n    host = 'github.com',\n    token: providedToken,\n  }) => {\n    const octokitOptions = await getOctokitOptions({\n      integrations,\n      credentialsProvider: githubCredentialsProvider,\n      host,\n      owner,\n      repo,\n      token: providedToken,\n    });\n\n    const OctokitPR = Octokit.plugin(createPullRequest);\n    return new OctokitPR({\n      ...octokitOptions,\n      ...{ throttle: { enabled: false } },\n    });\n  };\n\n/**\n * The options passed to {@link createPublishGithubPullRequestAction} method\n * @public\n */\nexport interface CreateGithubPullRequestActionOptions {\n  /**\n   * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.\n   */\n  integrations: ScmIntegrationRegistry;\n  /**\n   * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.\n   */\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  /**\n   * A method to return the Octokit client with the Pull Request Plugin.\n   */\n  clientFactory?: (input: {\n    integrations: ScmIntegrationRegistry;\n    githubCredentialsProvider?: GithubCredentialsProvider;\n    host: string;\n    owner: string;\n    repo: string;\n    token?: string;\n  }) => Promise<\n    Octokit & {\n      createPullRequest(options: createPullRequest.Options): Promise<{\n        data: {\n          html_url: string;\n          number: number;\n          base: {\n            ref: string;\n          };\n        };\n      } | null>;\n    }\n  >;\n  /**\n   * An instance of {@link @backstage/config#Config} that will be used in the action.\n   */\n  config?: Config;\n}\n\ntype GithubPullRequest = {\n  owner: string;\n  repo: string;\n  number: number;\n};\n\n/**\n * Creates a Github Pull Request action.\n * @public\n */\nexport const createPublishGithubPullRequestAction = (\n  options: CreateGithubPullRequestActionOptions,\n) => {\n  const {\n    integrations,\n    githubCredentialsProvider,\n    clientFactory = defaultClientFactory,\n    config,\n  } = options;\n\n  return createTemplateAction<{\n    title: string;\n    branchName: string;\n    targetBranchName?: string;\n    description: string;\n    repoUrl: string;\n    draft?: boolean;\n    targetPath?: string;\n    sourcePath?: string;\n    token?: string;\n    reviewers?: string[];\n    teamReviewers?: string[];\n    commitMessage?: string;\n    update?: boolean;\n    forceFork?: boolean;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    forceEmptyGitAuthor?: boolean;\n    createWhenEmpty?: boolean;\n  }>({\n    id: 'publish:github:pull-request',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        required: ['repoUrl', 'title', 'description', 'branchName'],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          branchName: {\n            type: 'string',\n            title: 'Branch Name',\n            description: 'The name for the branch',\n          },\n          targetBranchName: {\n            type: 'string',\n            title: 'Target Branch Name',\n            description: 'The target branch name of the pull request',\n          },\n          title: {\n            type: 'string',\n            title: 'Pull Request Name',\n            description: 'The name for the pull request',\n          },\n          description: {\n            type: 'string',\n            title: 'Pull Request Description',\n            description: 'The description of the pull request',\n          },\n          draft: {\n            type: 'boolean',\n            title: 'Create as Draft',\n            description: 'Create a draft pull request',\n          },\n          sourcePath: {\n            type: 'string',\n            title: 'Working Subdirectory',\n            description:\n              'Subdirectory of working directory to copy changes from',\n          },\n          targetPath: {\n            type: 'string',\n            title: 'Repository Subdirectory',\n            description: 'Subdirectory of repository to apply changes to',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n          reviewers: {\n            title: 'Pull Request Reviewers',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n            description:\n              'The users that will be added as reviewers to the pull request',\n          },\n          teamReviewers: {\n            title: 'Pull Request Team Reviewers',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n            description:\n              'The teams that will be added as reviewers to the pull request',\n          },\n          commitMessage: {\n            type: 'string',\n            title: 'Commit Message',\n            description: 'The commit message for the pull request commit',\n          },\n          update: {\n            type: 'boolean',\n            title: 'Update',\n            description: 'Update pull request if already exists',\n          },\n          forceFork: {\n            type: 'boolean',\n            title: 'Force Fork',\n            description: 'Create pull request from a fork',\n          },\n          gitAuthorName: {\n            type: 'string',\n            title: 'Default Author Name',\n            description:\n              'Sets the default author name for the commit. The default value is the authenticated user or `Scaffolder`',\n          },\n          gitAuthorEmail: {\n            type: 'string',\n            title: 'Default Author Email',\n            description:\n              'Sets the default author email for the commit. The default value is the authenticated user or `scaffolder@backstage.io`',\n          },\n          forceEmptyGitAuthor: {\n            type: 'boolean',\n            title: 'Force Empty Git Author',\n            description:\n              'Forces the author to be empty. This is useful when using a Github App, it permit the commit to be verified on Github',\n          },\n          createWhenEmpty: {\n            type: 'boolean',\n            title: 'Create When Empty',\n            description:\n              'Set whether to create pull request when there are no changes to commit. The default value is true. If set to false, remoteUrl is no longer a required output.',\n          },\n        },\n      },\n      output: {\n        required: [],\n        type: 'object',\n        properties: {\n          targetBranchName: {\n            title: 'Target branch name of the merge request',\n            type: 'string',\n          },\n          remoteUrl: {\n            type: 'string',\n            title: 'Pull Request URL',\n            description: 'Link to the pull request in Github',\n          },\n          pullRequestNumber: {\n            type: 'number',\n            title: 'Pull Request Number',\n            description: 'The pull request number',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branchName,\n        targetBranchName,\n        title,\n        description,\n        draft,\n        targetPath,\n        sourcePath,\n        token: providedToken,\n        reviewers,\n        teamReviewers,\n        commitMessage,\n        update,\n        forceFork,\n        gitAuthorEmail,\n        gitAuthorName,\n        forceEmptyGitAuthor,\n        createWhenEmpty,\n      } = ctx.input;\n\n      const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(\n          `No owner provided for host: ${host}, and repo ${repo}`,\n        );\n      }\n\n      const client = await clientFactory({\n        integrations,\n        githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const fileRoot = sourcePath\n        ? resolveSafeChildPath(ctx.workspacePath, sourcePath)\n        : ctx.workspacePath;\n\n      const directoryContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      const determineFileMode = (file: SerializedFile): string => {\n        if (file.symlink) return '120000';\n        if (file.executable) return '100755';\n        return '100644';\n      };\n\n      const determineFileEncoding = (\n        file: SerializedFile,\n      ): 'utf-8' | 'base64' => (file.symlink ? 'utf-8' : 'base64');\n\n      const files = Object.fromEntries(\n        directoryContents.map(file => [\n          targetPath ? path.posix.join(targetPath, file.path) : file.path,\n          {\n            // See the properties of tree items\n            // in https://docs.github.com/en/rest/reference/git#trees\n            mode: determineFileMode(file),\n            // Always use base64 encoding where possible to avoid doubling a binary file in size\n            // due to interpreting a binary file as utf-8 and sending github\n            // the utf-8 encoded content. Symlinks are kept as utf-8 to avoid them\n            // being formatted as a series of scrambled characters\n            //\n            // For example, the original gradle-wrapper.jar is 57.8k in https://github.com/kennethzfeng/pull-request-test/pull/5/files.\n            // Its size could be doubled to 98.3K (See https://github.com/kennethzfeng/pull-request-test/pull/4/files)\n            encoding: determineFileEncoding(file),\n            content: file.content.toString(determineFileEncoding(file)),\n          },\n        ]),\n      );\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating pull request`);\n        ctx.output('targetBranchName', branchName);\n        ctx.output('remoteUrl', repoUrl);\n        ctx.output('pullRequestNumber', 43);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const createOptions: createPullRequest.Options = {\n          owner,\n          repo,\n          title,\n          changes: [\n            {\n              files,\n              commit:\n                commitMessage ??\n                config?.getOptionalString('scaffolder.defaultCommitMessage') ??\n                title,\n            },\n          ],\n          body: description,\n          head: branchName,\n          draft,\n          update,\n          forceFork,\n          createWhenEmpty,\n        };\n\n        const gitAuthorInfo = {\n          name:\n            gitAuthorName ??\n            config?.getOptionalString('scaffolder.defaultAuthor.name'),\n          email:\n            gitAuthorEmail ??\n            config?.getOptionalString('scaffolder.defaultAuthor.email'),\n        };\n\n        if (!forceEmptyGitAuthor) {\n          if (gitAuthorInfo.name || gitAuthorInfo.email) {\n            if (Array.isArray(createOptions.changes)) {\n              createOptions.changes = createOptions.changes.map(change => ({\n                ...change,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              }));\n            } else {\n              createOptions.changes = {\n                ...createOptions.changes,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              };\n            }\n          }\n        }\n\n        if (targetBranchName) {\n          createOptions.base = targetBranchName;\n        }\n        const response = await client.createPullRequest(createOptions);\n\n        if (createWhenEmpty === false && !response) {\n          ctx.logger.info('No changes to commit, pull request was not created');\n          return;\n        }\n\n        if (!response) {\n          throw new GithubResponseError('null response from Github');\n        }\n\n        const pullRequestNumber = response.data.number;\n        if (reviewers || teamReviewers) {\n          const pullRequest = { owner, repo, number: pullRequestNumber };\n          await requestReviewersOnPullRequest(\n            pullRequest,\n            reviewers,\n            teamReviewers,\n            client,\n            ctx.logger,\n          );\n        }\n\n        const targetBranch = response.data.base.ref;\n        ctx.output('targetBranchName', targetBranch);\n        ctx.output('remoteUrl', response.data.html_url);\n        ctx.output('pullRequestNumber', pullRequestNumber);\n      } catch (e) {\n        throw new GithubResponseError('Pull request creation failed', e);\n      }\n    },\n  });\n\n  async function requestReviewersOnPullRequest(\n    pr: GithubPullRequest,\n    reviewers: string[] | undefined,\n    teamReviewers: string[] | undefined,\n    client: Octokit,\n    logger: LoggerService,\n  ) {\n    try {\n      const result = await client.rest.pulls.requestReviewers({\n        owner: pr.owner,\n        repo: pr.repo,\n        pull_number: pr.number,\n        reviewers,\n        team_reviewers: teamReviewers ? [...new Set(teamReviewers)] : undefined,\n      });\n      const addedUsers = result.data.requested_reviewers?.join(', ') ?? '';\n      const addedTeams = result.data.requested_teams?.join(', ') ?? '';\n      logger.info(\n        `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`,\n      );\n    } catch (e) {\n      logger.error(\n        `Failure when adding reviewers to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n};\n"],"names":["CustomErrorBase","getOctokitOptions","Octokit","createPullRequest","createTemplateAction","examples","parseRepoUrl","InputError","resolveSafeChildPath","serializeDirectoryContents","path"],"mappings":";;;;;;;;;;;;;;;AAwCA,MAAM,4BAA4BA,sBAAgB,CAAA;AAAC;AAE5C,MAAM,uBACX,OAAO;AAAA,EACL,YAAA;AAAA,EACA,yBAAA;AAAA,EACA,KAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAO,GAAA,YAAA;AAAA,EACP,KAAO,EAAA;AACT,CAAM,KAAA;AACJ,EAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,IAC7C,YAAA;AAAA,IACA,mBAAqB,EAAA,yBAAA;AAAA,IACrB,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAO,EAAA;AAAA,GACR,CAAA;AAED,EAAM,MAAA,SAAA,GAAYC,eAAQ,CAAA,MAAA,CAAOC,gDAAiB,CAAA;AAClD,EAAA,OAAO,IAAI,SAAU,CAAA;AAAA,IACnB,GAAG,cAAA;AAAA,IACH,GAAG,EAAE,QAAA,EAAU,EAAE,OAAA,EAAS,OAAQ;AAAA,GACnC,CAAA;AACH;AAsDW,MAAA,oCAAA,GAAuC,CAClD,OACG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,aAAgB,GAAA,oBAAA;AAAA,IAChB;AAAA,GACE,GAAA,OAAA;AAEJ,EAAA,OAAOC,yCAmBJ,CAAA;AAAA,IACD,EAAI,EAAA,6BAAA;AAAA,cACJC,mCAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAU,EAAA,CAAC,SAAW,EAAA,OAAA,EAAS,eAAe,YAAY,CAAA;AAAA,QAC1D,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,8IAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,gBAAkB,EAAA;AAAA,YAChB,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,WAAa,EAAA;AAAA,YACX,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,0BAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,sBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,yBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,wBAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA,aACR;AAAA,YACA,WACE,EAAA;AAAA,WACJ;AAAA,UACA,aAAe,EAAA;AAAA,YACb,KAAO,EAAA,6BAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA,aACR;AAAA,YACA,WACE,EAAA;AAAA,WACJ;AAAA,UACA,aAAe,EAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,gBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,YAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,aAAe,EAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,sBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,mBAAqB,EAAA;AAAA,YACnB,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,wBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,eAAiB,EAAA;AAAA,YACf,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA;AAAA;AACJ;AACF,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,UAAU,EAAC;AAAA,QACX,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,gBAAkB,EAAA;AAAA,YAChB,KAAO,EAAA,yCAAA;AAAA,YACP,IAAM,EAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA;AAAA;AACf;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,gBAAA;AAAA,QACA,KAAA;AAAA,QACA,WAAA;AAAA,QACA,KAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,SAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,cAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAM,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,IAAI,CAAA,WAAA,EAAc,IAAI,CAAA;AAAA,SACvD;AAAA;AAGF,MAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA;AAAA,QACjC,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAO,EAAA;AAAA,OACR,CAAA;AAED,MAAA,MAAM,WAAW,UACb,GAAAC,qCAAA,CAAqB,IAAI,aAAe,EAAA,UAAU,IAClD,GAAI,CAAA,aAAA;AAER,MAAM,MAAA,iBAAA,GAAoB,MAAMC,+CAAA,CAA2B,QAAU,EAAA;AAAA,QACnE,SAAW,EAAA;AAAA,OACZ,CAAA;AAED,MAAM,MAAA,iBAAA,GAAoB,CAAC,IAAiC,KAAA;AAC1D,QAAI,IAAA,IAAA,CAAK,SAAgB,OAAA,QAAA;AACzB,QAAI,IAAA,IAAA,CAAK,YAAmB,OAAA,QAAA;AAC5B,QAAO,OAAA,QAAA;AAAA,OACT;AAEA,MAAA,MAAM,qBAAwB,GAAA,CAC5B,IACwB,KAAA,IAAA,CAAK,UAAU,OAAU,GAAA,QAAA;AAEnD,MAAA,MAAM,QAAQ,MAAO,CAAA,WAAA;AAAA,QACnB,iBAAA,CAAkB,IAAI,CAAQ,IAAA,KAAA;AAAA,UAC5B,UAAA,GAAaC,sBAAK,KAAM,CAAA,IAAA,CAAK,YAAY,IAAK,CAAA,IAAI,IAAI,IAAK,CAAA,IAAA;AAAA,UAC3D;AAAA;AAAA;AAAA,YAGE,IAAA,EAAM,kBAAkB,IAAI,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAQ5B,QAAA,EAAU,sBAAsB,IAAI,CAAA;AAAA,YACpC,SAAS,IAAK,CAAA,OAAA,CAAQ,QAAS,CAAA,qBAAA,CAAsB,IAAI,CAAC;AAAA;AAC5D,SACD;AAAA,OACH;AAGA,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAA6C,2CAAA,CAAA,CAAA;AAC7D,QAAI,GAAA,CAAA,MAAA,CAAO,oBAAoB,UAAU,CAAA;AACzC,QAAI,GAAA,CAAA,MAAA,CAAO,aAAa,OAAO,CAAA;AAC/B,QAAI,GAAA,CAAA,MAAA,CAAO,qBAAqB,EAAE,CAAA;AAClC,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAA,MAAM,aAA2C,GAAA;AAAA,UAC/C,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAS,EAAA;AAAA,YACP;AAAA,cACE,KAAA;AAAA,cACA,MACE,EAAA,aAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,iCAAiC,CAC3D,IAAA;AAAA;AACJ,WACF;AAAA,UACA,IAAM,EAAA,WAAA;AAAA,UACN,IAAM,EAAA,UAAA;AAAA,UACN,KAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACF;AAEA,QAAA,MAAM,aAAgB,GAAA;AAAA,UACpB,IACE,EAAA,aAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,+BAA+B,CAAA;AAAA,UAC3D,KACE,EAAA,cAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,gCAAgC;AAAA,SAC9D;AAEA,QAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,UAAI,IAAA,aAAA,CAAc,IAAQ,IAAA,aAAA,CAAc,KAAO,EAAA;AAC7C,YAAA,IAAI,KAAM,CAAA,OAAA,CAAQ,aAAc,CAAA,OAAO,CAAG,EAAA;AACxC,cAAA,aAAA,CAAc,OAAU,GAAA,aAAA,CAAc,OAAQ,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,gBAC3D,GAAG,MAAA;AAAA,gBACH,MAAQ,EAAA;AAAA,kBACN,IAAA,EAAM,cAAc,IAAQ,IAAA,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAS,IAAA;AAAA;AAChC,eACA,CAAA,CAAA;AAAA,aACG,MAAA;AACL,cAAA,aAAA,CAAc,OAAU,GAAA;AAAA,gBACtB,GAAG,aAAc,CAAA,OAAA;AAAA,gBACjB,MAAQ,EAAA;AAAA,kBACN,IAAA,EAAM,cAAc,IAAQ,IAAA,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAS,IAAA;AAAA;AAChC,eACF;AAAA;AACF;AACF;AAGF,QAAA,IAAI,gBAAkB,EAAA;AACpB,UAAA,aAAA,CAAc,IAAO,GAAA,gBAAA;AAAA;AAEvB,QAAA,MAAM,QAAW,GAAA,MAAM,MAAO,CAAA,iBAAA,CAAkB,aAAa,CAAA;AAE7D,QAAI,IAAA,eAAA,KAAoB,KAAS,IAAA,CAAC,QAAU,EAAA;AAC1C,UAAI,GAAA,CAAA,MAAA,CAAO,KAAK,oDAAoD,CAAA;AACpE,UAAA;AAAA;AAGF,QAAA,IAAI,CAAC,QAAU,EAAA;AACb,UAAM,MAAA,IAAI,oBAAoB,2BAA2B,CAAA;AAAA;AAG3D,QAAM,MAAA,iBAAA,GAAoB,SAAS,IAAK,CAAA,MAAA;AACxC,QAAA,IAAI,aAAa,aAAe,EAAA;AAC9B,UAAA,MAAM,WAAc,GAAA,EAAE,KAAO,EAAA,IAAA,EAAM,QAAQ,iBAAkB,EAAA;AAC7D,UAAM,MAAA,6BAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAI,CAAA;AAAA,WACN;AAAA;AAGF,QAAM,MAAA,YAAA,GAAe,QAAS,CAAA,IAAA,CAAK,IAAK,CAAA,GAAA;AACxC,QAAI,GAAA,CAAA,MAAA,CAAO,oBAAoB,YAAY,CAAA;AAC3C,QAAA,GAAA,CAAI,MAAO,CAAA,WAAA,EAAa,QAAS,CAAA,IAAA,CAAK,QAAQ,CAAA;AAC9C,QAAI,GAAA,CAAA,MAAA,CAAO,qBAAqB,iBAAiB,CAAA;AAAA,eAC1C,CAAG,EAAA;AACV,QAAM,MAAA,IAAI,mBAAoB,CAAA,8BAAA,EAAgC,CAAC,CAAA;AAAA;AACjE;AACF,GACD,CAAA;AAED,EAAA,eAAe,6BACb,CAAA,EAAA,EACA,SACA,EAAA,aAAA,EACA,QACA,MACA,EAAA;AACA,IAAI,IAAA;AACF,MAAA,MAAM,MAAS,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,gBAAiB,CAAA;AAAA,QACtD,OAAO,EAAG,CAAA,KAAA;AAAA,QACV,MAAM,EAAG,CAAA,IAAA;AAAA,QACT,aAAa,EAAG,CAAA,MAAA;AAAA,QAChB,SAAA;AAAA,QACA,cAAA,EAAgB,gBAAgB,CAAC,GAAG,IAAI,GAAI,CAAA,aAAa,CAAC,CAAI,GAAA,KAAA;AAAA,OAC/D,CAAA;AACD,MAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAK,mBAAqB,EAAA,IAAA,CAAK,IAAI,CAAK,IAAA,EAAA;AAClE,MAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAK,eAAiB,EAAA,IAAA,CAAK,IAAI,CAAK,IAAA,EAAA;AAC9D,MAAO,MAAA,CAAA,IAAA;AAAA,QACL,gBAAgB,UAAU,CAAA,aAAA,EAAgB,UAAU,CAAA,+BAAA,EAAkC,GAAG,MAAM,CAAA;AAAA,OACjG;AAAA,aACO,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA;AACF;AAEJ;;;;;"}
+{"version":3,"file":"githubPullRequest.cjs.js","sources":["../../src/actions/githubPullRequest.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport path from 'path';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  SerializedFile,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { CustomErrorBase, InputError } from '@backstage/errors';\nimport { createPullRequest } from 'octokit-plugin-create-pull-request';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubPullRequest.examples';\nimport {\n  LoggerService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { JsonValue } from '@backstage/types';\n\nexport type Encoding = 'utf-8' | 'base64';\n\nclass GithubResponseError extends CustomErrorBase {}\n\nexport const defaultClientFactory: CreateGithubPullRequestActionOptions['clientFactory'] =\n  async ({\n    integrations,\n    githubCredentialsProvider,\n    owner,\n    repo,\n    host = 'github.com',\n    token: providedToken,\n  }) => {\n    const octokitOptions = await getOctokitOptions({\n      integrations,\n      credentialsProvider: githubCredentialsProvider,\n      host,\n      owner,\n      repo,\n      token: providedToken,\n    });\n\n    const OctokitPR = Octokit.plugin(createPullRequest);\n    return new OctokitPR({\n      ...octokitOptions,\n      ...{ throttle: { enabled: false } },\n    });\n  };\n\n/**\n * The options passed to {@link createPublishGithubPullRequestAction} method\n * @public\n */\nexport interface CreateGithubPullRequestActionOptions {\n  /**\n   * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.\n   */\n  integrations: ScmIntegrationRegistry;\n  /**\n   * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.\n   */\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  /**\n   * A method to return the Octokit client with the Pull Request Plugin.\n   */\n  clientFactory?: (input: {\n    integrations: ScmIntegrationRegistry;\n    githubCredentialsProvider?: GithubCredentialsProvider;\n    host: string;\n    owner: string;\n    repo: string;\n    token?: string;\n  }) => Promise<\n    Octokit & {\n      createPullRequest(options: createPullRequest.Options): Promise<{\n        data: {\n          html_url: string;\n          number: number;\n          base: {\n            ref: string;\n          };\n        };\n      } | null>;\n    }\n  >;\n  /**\n   * An instance of {@link @backstage/config#Config} that will be used in the action.\n   */\n  config?: Config;\n}\n\ntype GithubPullRequest = {\n  owner: string;\n  repo: string;\n  number: number;\n};\n\n/**\n * Creates a Github Pull Request action.\n * @public\n */\nexport const createPublishGithubPullRequestAction = (\n  options: CreateGithubPullRequestActionOptions,\n) => {\n  const {\n    integrations,\n    githubCredentialsProvider,\n    clientFactory = defaultClientFactory,\n    config,\n  } = options;\n\n  return createTemplateAction<{\n    title: string;\n    branchName: string;\n    targetBranchName?: string;\n    description: string;\n    repoUrl: string;\n    draft?: boolean;\n    targetPath?: string;\n    sourcePath?: string;\n    token?: string;\n    reviewers?: string[];\n    teamReviewers?: string[];\n    commitMessage?: string;\n    update?: boolean;\n    forceFork?: boolean;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    forceEmptyGitAuthor?: boolean;\n    createWhenEmpty?: boolean;\n  }>({\n    id: 'publish:github:pull-request',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        required: ['repoUrl', 'title', 'description', 'branchName'],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          branchName: {\n            type: 'string',\n            title: 'Branch Name',\n            description: 'The name for the branch',\n          },\n          targetBranchName: {\n            type: 'string',\n            title: 'Target Branch Name',\n            description: 'The target branch name of the pull request',\n          },\n          title: {\n            type: 'string',\n            title: 'Pull Request Name',\n            description: 'The name for the pull request',\n          },\n          description: {\n            type: 'string',\n            title: 'Pull Request Description',\n            description: 'The description of the pull request',\n          },\n          draft: {\n            type: 'boolean',\n            title: 'Create as Draft',\n            description: 'Create a draft pull request',\n          },\n          sourcePath: {\n            type: 'string',\n            title: 'Working Subdirectory',\n            description:\n              'Subdirectory of working directory to copy changes from',\n          },\n          targetPath: {\n            type: 'string',\n            title: 'Repository Subdirectory',\n            description: 'Subdirectory of repository to apply changes to',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n          reviewers: {\n            title: 'Pull Request Reviewers',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n            description:\n              'The users that will be added as reviewers to the pull request',\n          },\n          teamReviewers: {\n            title: 'Pull Request Team Reviewers',\n            type: 'array',\n            items: {\n              type: 'string',\n            },\n            description:\n              'The teams that will be added as reviewers to the pull request',\n          },\n          commitMessage: {\n            type: 'string',\n            title: 'Commit Message',\n            description: 'The commit message for the pull request commit',\n          },\n          update: {\n            type: 'boolean',\n            title: 'Update',\n            description: 'Update pull request if already exists',\n          },\n          forceFork: {\n            type: 'boolean',\n            title: 'Force Fork',\n            description: 'Create pull request from a fork',\n          },\n          gitAuthorName: {\n            type: 'string',\n            title: 'Default Author Name',\n            description:\n              'Sets the default author name for the commit. The default value is the authenticated user or `Scaffolder`',\n          },\n          gitAuthorEmail: {\n            type: 'string',\n            title: 'Default Author Email',\n            description:\n              'Sets the default author email for the commit. The default value is the authenticated user or `scaffolder@backstage.io`',\n          },\n          forceEmptyGitAuthor: {\n            type: 'boolean',\n            title: 'Force Empty Git Author',\n            description:\n              'Forces the author to be empty. This is useful when using a Github App, it permit the commit to be verified on Github',\n          },\n          createWhenEmpty: {\n            type: 'boolean',\n            title: 'Create When Empty',\n            description:\n              'Set whether to create pull request when there are no changes to commit. The default value is true. If set to false, remoteUrl is no longer a required output.',\n          },\n        },\n      },\n      output: {\n        required: [],\n        type: 'object',\n        properties: {\n          targetBranchName: {\n            title: 'Target branch name of the merge request',\n            type: 'string',\n          },\n          remoteUrl: {\n            type: 'string',\n            title: 'Pull Request URL',\n            description: 'Link to the pull request in Github',\n          },\n          pullRequestNumber: {\n            type: 'number',\n            title: 'Pull Request Number',\n            description: 'The pull request number',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branchName,\n        targetBranchName,\n        title,\n        description,\n        draft,\n        targetPath,\n        sourcePath,\n        token: providedToken,\n        reviewers,\n        teamReviewers,\n        commitMessage,\n        update,\n        forceFork,\n        gitAuthorEmail,\n        gitAuthorName,\n        forceEmptyGitAuthor,\n        createWhenEmpty,\n      } = ctx.input;\n\n      const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(\n          `No owner provided for host: ${host}, and repo ${repo}`,\n        );\n      }\n\n      const client = await clientFactory({\n        integrations,\n        githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const fileRoot = sourcePath\n        ? resolveSafeChildPath(ctx.workspacePath, sourcePath)\n        : ctx.workspacePath;\n\n      const directoryContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      const determineFileMode = (file: SerializedFile): string => {\n        if (file.symlink) return '120000';\n        if (file.executable) return '100755';\n        return '100644';\n      };\n\n      const determineFileEncoding = (\n        file: SerializedFile,\n      ): 'utf-8' | 'base64' => (file.symlink ? 'utf-8' : 'base64');\n\n      const files = Object.fromEntries(\n        directoryContents.map(file => [\n          targetPath ? path.posix.join(targetPath, file.path) : file.path,\n          {\n            // See the properties of tree items\n            // in https://docs.github.com/en/rest/reference/git#trees\n            mode: determineFileMode(file),\n            // Always use base64 encoding where possible to avoid doubling a binary file in size\n            // due to interpreting a binary file as utf-8 and sending github\n            // the utf-8 encoded content. Symlinks are kept as utf-8 to avoid them\n            // being formatted as a series of scrambled characters\n            //\n            // For example, the original gradle-wrapper.jar is 57.8k in https://github.com/kennethzfeng/pull-request-test/pull/5/files.\n            // Its size could be doubled to 98.3K (See https://github.com/kennethzfeng/pull-request-test/pull/4/files)\n            encoding: determineFileEncoding(file),\n            content: file.content.toString(determineFileEncoding(file)),\n          },\n        ]),\n      );\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating pull request`);\n        ctx.output('targetBranchName', branchName);\n        ctx.output('remoteUrl', repoUrl);\n        ctx.output('pullRequestNumber', 43);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const createOptions: createPullRequest.Options = {\n          owner,\n          repo,\n          title,\n          changes: [\n            {\n              files,\n              commit:\n                commitMessage ??\n                config?.getOptionalString('scaffolder.defaultCommitMessage') ??\n                title,\n            },\n          ],\n          body: description,\n          head: branchName,\n          draft,\n          update,\n          forceFork,\n          createWhenEmpty,\n        };\n\n        const gitAuthorInfo = {\n          name:\n            gitAuthorName ??\n            config?.getOptionalString('scaffolder.defaultAuthor.name'),\n          email:\n            gitAuthorEmail ??\n            config?.getOptionalString('scaffolder.defaultAuthor.email'),\n        };\n\n        if (!forceEmptyGitAuthor) {\n          if (gitAuthorInfo.name || gitAuthorInfo.email) {\n            if (Array.isArray(createOptions.changes)) {\n              createOptions.changes = createOptions.changes.map(change => ({\n                ...change,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              }));\n            } else {\n              createOptions.changes = {\n                ...createOptions.changes,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              };\n            }\n          }\n        }\n\n        if (targetBranchName) {\n          createOptions.base = targetBranchName;\n        }\n\n        const pr = await ctx.checkpoint({\n          key: `create.pr.${owner}.${repo}.${branchName}`,\n          fn: async () => {\n            const response = await client.createPullRequest(createOptions);\n            if (!response) {\n              return null;\n            }\n\n            return {\n              base: response?.data.base,\n              html_url: response?.data.html_url,\n              number: response?.data.number,\n            };\n          },\n        });\n\n        if (createWhenEmpty === false && !pr) {\n          ctx.logger.info('No changes to commit, pull request was not created');\n          return;\n        }\n\n        if (!pr) {\n          throw new GithubResponseError('null response from Github');\n        }\n\n        const pullRequestNumber = pr.number;\n        if (reviewers || teamReviewers) {\n          const pullRequest = { owner, repo, number: pullRequestNumber };\n          await requestReviewersOnPullRequest(\n            pullRequest,\n            reviewers,\n            teamReviewers,\n            client,\n            ctx.logger,\n            ctx.checkpoint,\n          );\n        }\n\n        const targetBranch = pr.base.ref;\n        ctx.output('targetBranchName', targetBranch);\n        ctx.output('remoteUrl', pr.html_url);\n        ctx.output('pullRequestNumber', pullRequestNumber);\n      } catch (e) {\n        throw new GithubResponseError('Pull request creation failed', e);\n      }\n    },\n  });\n\n  async function requestReviewersOnPullRequest(\n    pr: GithubPullRequest,\n    reviewers: string[] | undefined,\n    teamReviewers: string[] | undefined,\n    client: Octokit,\n    logger: LoggerService,\n    checkpoint: <T extends JsonValue | void>(opts: {\n      key: string;\n      fn: () => Promise<T> | T;\n    }) => Promise<T>,\n  ) {\n    try {\n      await checkpoint({\n        key: `request.reviewers.${pr.owner}.${pr.repo}.${pr.number}`,\n        fn: async () => {\n          const result = await client.rest.pulls.requestReviewers({\n            owner: pr.owner,\n            repo: pr.repo,\n            pull_number: pr.number,\n            reviewers,\n            team_reviewers: teamReviewers\n              ? [...new Set(teamReviewers)]\n              : undefined,\n          });\n\n          const addedUsers = result.data.requested_reviewers?.join(', ') ?? '';\n          const addedTeams = result.data.requested_teams?.join(', ') ?? '';\n\n          logger.info(\n            `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`,\n          );\n        },\n      });\n    } catch (e) {\n      logger.error(\n        `Failure when adding reviewers to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n};\n"],"names":["CustomErrorBase","getOctokitOptions","Octokit","createPullRequest","createTemplateAction","examples","parseRepoUrl","InputError","resolveSafeChildPath","serializeDirectoryContents","path"],"mappings":";;;;;;;;;;;;;;;AAyCA,MAAM,4BAA4BA,sBAAgB,CAAA;AAAC;AAE5C,MAAM,uBACX,OAAO;AAAA,EACL,YAAA;AAAA,EACA,yBAAA;AAAA,EACA,KAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAO,GAAA,YAAA;AAAA,EACP,KAAO,EAAA;AACT,CAAM,KAAA;AACJ,EAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,IAC7C,YAAA;AAAA,IACA,mBAAqB,EAAA,yBAAA;AAAA,IACrB,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAO,EAAA;AAAA,GACR,CAAA;AAED,EAAM,MAAA,SAAA,GAAYC,eAAQ,CAAA,MAAA,CAAOC,gDAAiB,CAAA;AAClD,EAAA,OAAO,IAAI,SAAU,CAAA;AAAA,IACnB,GAAG,cAAA;AAAA,IACH,GAAG,EAAE,QAAA,EAAU,EAAE,OAAA,EAAS,OAAQ;AAAA,GACnC,CAAA;AACH;AAsDW,MAAA,oCAAA,GAAuC,CAClD,OACG,KAAA;AACH,EAAM,MAAA;AAAA,IACJ,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,aAAgB,GAAA,oBAAA;AAAA,IAChB;AAAA,GACE,GAAA,OAAA;AAEJ,EAAA,OAAOC,yCAmBJ,CAAA;AAAA,IACD,EAAI,EAAA,6BAAA;AAAA,cACJC,mCAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAU,EAAA,CAAC,SAAW,EAAA,OAAA,EAAS,eAAe,YAAY,CAAA;AAAA,QAC1D,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,8IAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,gBAAkB,EAAA;AAAA,YAChB,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,WAAa,EAAA;AAAA,YACX,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,0BAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,sBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,yBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,wBAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA,aACR;AAAA,YACA,WACE,EAAA;AAAA,WACJ;AAAA,UACA,aAAe,EAAA;AAAA,YACb,KAAO,EAAA,6BAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,YACN,KAAO,EAAA;AAAA,cACL,IAAM,EAAA;AAAA,aACR;AAAA,YACA,WACE,EAAA;AAAA,WACJ;AAAA,UACA,aAAe,EAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,gBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,YAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,aAAe,EAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,sBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,mBAAqB,EAAA;AAAA,YACnB,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,wBAAA;AAAA,YACP,WACE,EAAA;AAAA,WACJ;AAAA,UACA,eAAiB,EAAA;AAAA,YACf,IAAM,EAAA,SAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA;AAAA;AACJ;AACF,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,UAAU,EAAC;AAAA,QACX,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,gBAAkB,EAAA;AAAA,YAChB,KAAO,EAAA,yCAAA;AAAA,YACP,IAAM,EAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA;AAAA,WACf;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA;AAAA;AACf;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,gBAAA;AAAA,QACA,KAAA;AAAA,QACA,WAAA;AAAA,QACA,KAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,SAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,cAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,UACE,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAM,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,IAAI,CAAA,WAAA,EAAc,IAAI,CAAA;AAAA,SACvD;AAAA;AAGF,MAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA;AAAA,QACjC,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAO,EAAA;AAAA,OACR,CAAA;AAED,MAAA,MAAM,WAAW,UACb,GAAAC,qCAAA,CAAqB,IAAI,aAAe,EAAA,UAAU,IAClD,GAAI,CAAA,aAAA;AAER,MAAM,MAAA,iBAAA,GAAoB,MAAMC,+CAAA,CAA2B,QAAU,EAAA;AAAA,QACnE,SAAW,EAAA;AAAA,OACZ,CAAA;AAED,MAAM,MAAA,iBAAA,GAAoB,CAAC,IAAiC,KAAA;AAC1D,QAAI,IAAA,IAAA,CAAK,SAAgB,OAAA,QAAA;AACzB,QAAI,IAAA,IAAA,CAAK,YAAmB,OAAA,QAAA;AAC5B,QAAO,OAAA,QAAA;AAAA,OACT;AAEA,MAAA,MAAM,qBAAwB,GAAA,CAC5B,IACwB,KAAA,IAAA,CAAK,UAAU,OAAU,GAAA,QAAA;AAEnD,MAAA,MAAM,QAAQ,MAAO,CAAA,WAAA;AAAA,QACnB,iBAAA,CAAkB,IAAI,CAAQ,IAAA,KAAA;AAAA,UAC5B,UAAA,GAAaC,sBAAK,KAAM,CAAA,IAAA,CAAK,YAAY,IAAK,CAAA,IAAI,IAAI,IAAK,CAAA,IAAA;AAAA,UAC3D;AAAA;AAAA;AAAA,YAGE,IAAA,EAAM,kBAAkB,IAAI,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAQ5B,QAAA,EAAU,sBAAsB,IAAI,CAAA;AAAA,YACpC,SAAS,IAAK,CAAA,OAAA,CAAQ,QAAS,CAAA,qBAAA,CAAsB,IAAI,CAAC;AAAA;AAC5D,SACD;AAAA,OACH;AAGA,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAA6C,2CAAA,CAAA,CAAA;AAC7D,QAAI,GAAA,CAAA,MAAA,CAAO,oBAAoB,UAAU,CAAA;AACzC,QAAI,GAAA,CAAA,MAAA,CAAO,aAAa,OAAO,CAAA;AAC/B,QAAI,GAAA,CAAA,MAAA,CAAO,qBAAqB,EAAE,CAAA;AAClC,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAA,MAAM,aAA2C,GAAA;AAAA,UAC/C,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAS,EAAA;AAAA,YACP;AAAA,cACE,KAAA;AAAA,cACA,MACE,EAAA,aAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,iCAAiC,CAC3D,IAAA;AAAA;AACJ,WACF;AAAA,UACA,IAAM,EAAA,WAAA;AAAA,UACN,IAAM,EAAA,UAAA;AAAA,UACN,KAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACF;AAEA,QAAA,MAAM,aAAgB,GAAA;AAAA,UACpB,IACE,EAAA,aAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,+BAA+B,CAAA;AAAA,UAC3D,KACE,EAAA,cAAA,IACA,MAAQ,EAAA,iBAAA,CAAkB,gCAAgC;AAAA,SAC9D;AAEA,QAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,UAAI,IAAA,aAAA,CAAc,IAAQ,IAAA,aAAA,CAAc,KAAO,EAAA;AAC7C,YAAA,IAAI,KAAM,CAAA,OAAA,CAAQ,aAAc,CAAA,OAAO,CAAG,EAAA;AACxC,cAAA,aAAA,CAAc,OAAU,GAAA,aAAA,CAAc,OAAQ,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,gBAC3D,GAAG,MAAA;AAAA,gBACH,MAAQ,EAAA;AAAA,kBACN,IAAA,EAAM,cAAc,IAAQ,IAAA,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAS,IAAA;AAAA;AAChC,eACA,CAAA,CAAA;AAAA,aACG,MAAA;AACL,cAAA,aAAA,CAAc,OAAU,GAAA;AAAA,gBACtB,GAAG,aAAc,CAAA,OAAA;AAAA,gBACjB,MAAQ,EAAA;AAAA,kBACN,IAAA,EAAM,cAAc,IAAQ,IAAA,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAS,IAAA;AAAA;AAChC,eACF;AAAA;AACF;AACF;AAGF,QAAA,IAAI,gBAAkB,EAAA;AACpB,UAAA,aAAA,CAAc,IAAO,GAAA,gBAAA;AAAA;AAGvB,QAAM,MAAA,EAAA,GAAK,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,UAC9B,KAAK,CAAa,UAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UAC7C,IAAI,YAAY;AACd,YAAA,MAAM,QAAW,GAAA,MAAM,MAAO,CAAA,iBAAA,CAAkB,aAAa,CAAA;AAC7D,YAAA,IAAI,CAAC,QAAU,EAAA;AACb,cAAO,OAAA,IAAA;AAAA;AAGT,YAAO,OAAA;AAAA,cACL,IAAA,EAAM,UAAU,IAAK,CAAA,IAAA;AAAA,cACrB,QAAA,EAAU,UAAU,IAAK,CAAA,QAAA;AAAA,cACzB,MAAA,EAAQ,UAAU,IAAK,CAAA;AAAA,aACzB;AAAA;AACF,SACD,CAAA;AAED,QAAI,IAAA,eAAA,KAAoB,KAAS,IAAA,CAAC,EAAI,EAAA;AACpC,UAAI,GAAA,CAAA,MAAA,CAAO,KAAK,oDAAoD,CAAA;AACpE,UAAA;AAAA;AAGF,QAAA,IAAI,CAAC,EAAI,EAAA;AACP,UAAM,MAAA,IAAI,oBAAoB,2BAA2B,CAAA;AAAA;AAG3D,QAAA,MAAM,oBAAoB,EAAG,CAAA,MAAA;AAC7B,QAAA,IAAI,aAAa,aAAe,EAAA;AAC9B,UAAA,MAAM,WAAc,GAAA,EAAE,KAAO,EAAA,IAAA,EAAM,QAAQ,iBAAkB,EAAA;AAC7D,UAAM,MAAA,6BAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAI,CAAA,MAAA;AAAA,YACJ,GAAI,CAAA;AAAA,WACN;AAAA;AAGF,QAAM,MAAA,YAAA,GAAe,GAAG,IAAK,CAAA,GAAA;AAC7B,QAAI,GAAA,CAAA,MAAA,CAAO,oBAAoB,YAAY,CAAA;AAC3C,QAAI,GAAA,CAAA,MAAA,CAAO,WAAa,EAAA,EAAA,CAAG,QAAQ,CAAA;AACnC,QAAI,GAAA,CAAA,MAAA,CAAO,qBAAqB,iBAAiB,CAAA;AAAA,eAC1C,CAAG,EAAA;AACV,QAAM,MAAA,IAAI,mBAAoB,CAAA,8BAAA,EAAgC,CAAC,CAAA;AAAA;AACjE;AACF,GACD,CAAA;AAED,EAAA,eAAe,8BACb,EACA,EAAA,SAAA,EACA,aACA,EAAA,MAAA,EACA,QACA,UAIA,EAAA;AACA,IAAI,IAAA;AACF,MAAA,MAAM,UAAW,CAAA;AAAA,QACf,GAAA,EAAK,qBAAqB,EAAG,CAAA,KAAK,IAAI,EAAG,CAAA,IAAI,CAAI,CAAA,EAAA,EAAA,CAAG,MAAM,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAA,MAAM,MAAS,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,gBAAiB,CAAA;AAAA,YACtD,OAAO,EAAG,CAAA,KAAA;AAAA,YACV,MAAM,EAAG,CAAA,IAAA;AAAA,YACT,aAAa,EAAG,CAAA,MAAA;AAAA,YAChB,SAAA;AAAA,YACA,cAAA,EAAgB,gBACZ,CAAC,GAAG,IAAI,GAAI,CAAA,aAAa,CAAC,CAC1B,GAAA,KAAA;AAAA,WACL,CAAA;AAED,UAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAK,mBAAqB,EAAA,IAAA,CAAK,IAAI,CAAK,IAAA,EAAA;AAClE,UAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAK,eAAiB,EAAA,IAAA,CAAK,IAAI,CAAK,IAAA,EAAA;AAE9D,UAAO,MAAA,CAAA,IAAA;AAAA,YACL,gBAAgB,UAAU,CAAA,aAAA,EAAgB,UAAU,CAAA,+BAAA,EAAkC,GAAG,MAAM,CAAA;AAAA,WACjG;AAAA;AACF,OACD,CAAA;AAAA,aACM,CAAG,EAAA;AACV,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA;AACF;AAEJ;;;;;"}

package/dist/actions/githubRepoCreate.cjs.js

@@ -101,34 +101,40 @@ function createGithubRepoCreateAction(options) {
         repo
       });
       const client = new octokit.Octokit(octokitOptions);
-      const newRepo = await helpers.createGithubRepoWithCollaboratorsAndTopics(
-        client,
-        repo,
-        owner,
-        repoVisibility,
-        description,
-        homepage,
-        deleteBranchOnMerge,
-        allowMergeCommit,
-        allowSquashMerge,
-        squashMergeCommitTitle,
-        squashMergeCommitMessage,
-        allowRebaseMerge,
-        allowAutoMerge,
-        access,
-        collaborators,
-        hasProjects,
-        hasWiki,
-        hasIssues,
-        topics,
-        repoVariables,
-        secrets,
-        oidcCustomization,
-        customProperties,
-        subscribe,
-        ctx.logger
-      );
-      ctx.output("remoteUrl", newRepo.clone_url);
+      const remoteUrl = await ctx.checkpoint({
+        key: `create.repo.and.topics.${owner}.${repo}`,
+        fn: async () => {
+          const newRepo = await helpers.createGithubRepoWithCollaboratorsAndTopics(
+            client,
+            repo,
+            owner,
+            repoVisibility,
+            description,
+            homepage,
+            deleteBranchOnMerge,
+            allowMergeCommit,
+            allowSquashMerge,
+            squashMergeCommitTitle,
+            squashMergeCommitMessage,
+            allowRebaseMerge,
+            allowAutoMerge,
+            access,
+            collaborators,
+            hasProjects,
+            hasWiki,
+            hasIssues,
+            topics,
+            repoVariables,
+            secrets,
+            oidcCustomization,
+            customProperties,
+            subscribe,
+            ctx.logger
+          );
+          return newRepo.clone_url;
+        }
+      });
+      ctx.output("remoteUrl", remoteUrl);
     }
   });
 }

package/dist/actions/githubRepoCreate.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubRepoCreate.cjs.js","sources":["../../src/actions/githubRepoCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { createGithubRepoWithCollaboratorsAndTopics } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoCreate.examples';\n\n/**\n * Creates a new action that initializes a git repository\n *\n * @public\n */\nexport function createGithubRepoCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    description?: string;\n    homepage?: string;\n    access?: string;\n    deleteBranchOnMerge?: boolean;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    allowRebaseMerge?: boolean;\n    allowSquashMerge?: boolean;\n    squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';\n    squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';\n    allowMergeCommit?: boolean;\n    allowAutoMerge?: boolean;\n    requireCodeOwnerReviews?: boolean;\n    bypassPullRequestAllowances?: {\n      users?: string[];\n      teams?: string[];\n      apps?: string[];\n    };\n    requiredApprovingReviewCount?: number;\n    restrictions?: {\n      users: string[];\n      teams: string[];\n      apps?: string[];\n    };\n    requiredStatusCheckContexts?: string[];\n    requireBranchesToBeUpToDate?: boolean;\n    requiredConversationResolution?: boolean;\n    repoVisibility?: 'private' | 'internal' | 'public';\n    collaborators?: Array<\n      | {\n          user: string;\n          access: string;\n        }\n      | {\n          team: string;\n          access: string;\n        }\n      | {\n          /** @deprecated This field is deprecated in favor of team */\n          username: string;\n          access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';\n        }\n    >;\n    hasProjects?: boolean;\n    hasWiki?: boolean;\n    hasIssues?: boolean;\n    token?: string;\n    topics?: string[];\n    repoVariables?: { [key: string]: string };\n    secrets?: { [key: string]: string };\n    oidcCustomization?: {\n      useDefault: boolean;\n      includeClaimKeys?: string[];\n    };\n    requireCommitSigning?: boolean;\n    requiredLinearHistory?: boolean;\n    customProperties?: { [key: string]: string };\n    subscribe?: boolean;\n  }>({\n    id: 'github:repo:create',\n    description: 'Creates a GitHub repository.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: inputProps.repoUrl,\n          description: inputProps.description,\n          homepage: inputProps.homepage,\n          access: inputProps.access,\n          requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n          bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n          requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n          restrictions: inputProps.restrictions,\n          requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n          requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n          requiredConversationResolution:\n            inputProps.requiredConversationResolution,\n          repoVisibility: inputProps.repoVisibility,\n          deleteBranchOnMerge: inputProps.deleteBranchOnMerge,\n          allowMergeCommit: inputProps.allowMergeCommit,\n          allowSquashMerge: inputProps.allowSquashMerge,\n          squashMergeCommitTitle: inputProps.squashMergeCommitTitle,\n          squashMergeCommitMessage: inputProps.squashMergeCommitMessage,\n          allowRebaseMerge: inputProps.allowRebaseMerge,\n          allowAutoMerge: inputProps.allowAutoMerge,\n          collaborators: inputProps.collaborators,\n          hasProjects: inputProps.hasProjects,\n          hasWiki: inputProps.hasWiki,\n          hasIssues: inputProps.hasIssues,\n          token: inputProps.token,\n          topics: inputProps.topics,\n          repoVariables: inputProps.repoVariables,\n          secrets: inputProps.secrets,\n          oidcCustomization: inputProps.oidcCustomization,\n          requiredCommitSigning: inputProps.requiredCommitSigning,\n          requiredLinearHistory: inputProps.requiredLinearHistory,\n          customProperties: inputProps.customProperties,\n          subscribe: inputProps.subscribe,\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          remoteUrl: outputProps.remoteUrl,\n          repoContentsUrl: outputProps.repoContentsUrl,\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\n        repoVisibility = 'private',\n        deleteBranchOnMerge = false,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        subscribe,\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit(octokitOptions);\n\n      const newRepo = await createGithubRepoWithCollaboratorsAndTopics(\n        client,\n        repo,\n        owner,\n        repoVisibility,\n        description,\n        homepage,\n        deleteBranchOnMerge,\n        allowMergeCommit,\n        allowSquashMerge,\n        squashMergeCommitTitle,\n        squashMergeCommitMessage,\n        allowRebaseMerge,\n        allowAutoMerge,\n        access,\n        collaborators,\n        hasProjects,\n        hasWiki,\n        hasIssues,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        subscribe,\n        ctx.logger,\n      );\n\n      ctx.output('remoteUrl', newRepo.clone_url);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.description","inputProps.homepage","inputProps.access","inputProps.requireCodeOwnerReviews","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.repoVisibility","inputProps.deleteBranchOnMerge","inputProps.allowMergeCommit","inputProps.allowSquashMerge","inputProps.squashMergeCommitTitle","inputProps.squashMergeCommitMessage","inputProps.allowRebaseMerge","inputProps.allowAutoMerge","inputProps.collaborators","inputProps.hasProjects","inputProps.hasWiki","inputProps.hasIssues","inputProps.token","inputProps.topics","inputProps.repoVariables","inputProps.secrets","inputProps.oidcCustomization","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","inputProps.customProperties","inputProps.subscribe","outputProps.remoteUrl","outputProps.repoContentsUrl","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics"],"mappings":";;;;;;;;;;;AAqCO,SAAS,6BAA6B,OAG1C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCA4DJ,CAAA;AAAA,IACD,EAAI,EAAA,oBAAA;AAAA,IACJ,WAAa,EAAA,8BAAA;AAAA,cACbC,kCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,SAASC,uBAAW;AAAA,UACpB,aAAaC,2BAAW;AAAA,UACxB,UAAUC,wBAAW;AAAA,UACrB,QAAQC,sBAAW;AAAA,UACnB,yBAAyBC,uCAAW;AAAA,UACpC,6BAA6BC,2CAAW;AAAA,UACxC,8BAA8BC,4CAAW;AAAA,UACzC,cAAcC,4BAAW;AAAA,UACzB,6BAA6BC,2CAAW;AAAA,UACxC,6BAA6BC,2CAAW;AAAA,UACxC,gCACEC,8CAAW;AAAA,UACb,gBAAgBC,8BAAW;AAAA,UAC3B,qBAAqBC,mCAAW;AAAA,UAChC,kBAAkBC,gCAAW;AAAA,UAC7B,kBAAkBC,gCAAW;AAAA,UAC7B,wBAAwBC,sCAAW;AAAA,UACnC,0BAA0BC,wCAAW;AAAA,UACrC,kBAAkBC,gCAAW;AAAA,UAC7B,gBAAgBC,8BAAW;AAAA,UAC3B,eAAeC,6BAAW;AAAA,UAC1B,aAAaC,2BAAW;AAAA,UACxB,SAASC,uBAAW;AAAA,UACpB,WAAWC,yBAAW;AAAA,UACtB,OAAOC,qBAAW;AAAA,UAClB,QAAQC,sBAAW;AAAA,UACnB,eAAeC,6BAAW;AAAA,UAC1B,SAASC,uBAAW;AAAA,UACpB,mBAAmBC,iCAAW;AAAA,UAC9B,uBAAuBC,qCAAW;AAAA,UAClC,uBAAuBC,qCAAW;AAAA,UAClC,kBAAkBC,gCAAW;AAAA,UAC7B,WAAWC;AAAW;AACxB,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,WAAWC,0BAAY;AAAA,UACvB,iBAAiBC;AAAY;AAC/B;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,cAAiB,GAAA,SAAA;AAAA,QACjB,mBAAsB,GAAA,KAAA;AAAA,QACtB,gBAAmB,GAAA,IAAA;AAAA,QACnB,gBAAmB,GAAA,IAAA;AAAA,QACnB,sBAAyB,GAAA,oBAAA;AAAA,QACzB,wBAA2B,GAAA,iBAAA;AAAA,QAC3B,gBAAmB,GAAA,IAAA;AAAA,QACnB,cAAiB,GAAA,KAAA;AAAA,QACjB,aAAA;AAAA,QACA,WAAc,GAAA,KAAA,CAAA;AAAA,QACd,OAAU,GAAA,KAAA,CAAA;AAAA,QACV,SAAY,GAAA,KAAA,CAAA;AAAA,QACZ,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,gBAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAA,MAAM,UAAU,MAAMC,kDAAA;AAAA,QACpB,MAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,cAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,mBAAA;AAAA,QACA,gBAAA;AAAA,QACA,gBAAA;AAAA,QACA,sBAAA;AAAA,QACA,wBAAA;AAAA,QACA,gBAAA;AAAA,QACA,cAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,WAAA;AAAA,QACA,OAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,gBAAA;AAAA,QACA,SAAA;AAAA,QACA,GAAI,CAAA;AAAA,OACN;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,WAAa,EAAA,OAAA,CAAQ,SAAS,CAAA;AAAA;AAC3C,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubRepoCreate.cjs.js","sources":["../../src/actions/githubRepoCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { createGithubRepoWithCollaboratorsAndTopics } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoCreate.examples';\n\n/**\n * Creates a new action that initializes a git repository\n *\n * @public\n */\nexport function createGithubRepoCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    description?: string;\n    homepage?: string;\n    access?: string;\n    deleteBranchOnMerge?: boolean;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    allowRebaseMerge?: boolean;\n    allowSquashMerge?: boolean;\n    squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';\n    squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';\n    allowMergeCommit?: boolean;\n    allowAutoMerge?: boolean;\n    requireCodeOwnerReviews?: boolean;\n    bypassPullRequestAllowances?: {\n      users?: string[];\n      teams?: string[];\n      apps?: string[];\n    };\n    requiredApprovingReviewCount?: number;\n    restrictions?: {\n      users: string[];\n      teams: string[];\n      apps?: string[];\n    };\n    requiredStatusCheckContexts?: string[];\n    requireBranchesToBeUpToDate?: boolean;\n    requiredConversationResolution?: boolean;\n    repoVisibility?: 'private' | 'internal' | 'public';\n    collaborators?: Array<\n      | {\n          user: string;\n          access: string;\n        }\n      | {\n          team: string;\n          access: string;\n        }\n      | {\n          /** @deprecated This field is deprecated in favor of team */\n          username: string;\n          access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';\n        }\n    >;\n    hasProjects?: boolean;\n    hasWiki?: boolean;\n    hasIssues?: boolean;\n    token?: string;\n    topics?: string[];\n    repoVariables?: { [key: string]: string };\n    secrets?: { [key: string]: string };\n    oidcCustomization?: {\n      useDefault: boolean;\n      includeClaimKeys?: string[];\n    };\n    requireCommitSigning?: boolean;\n    requiredLinearHistory?: boolean;\n    customProperties?: { [key: string]: string };\n    subscribe?: boolean;\n  }>({\n    id: 'github:repo:create',\n    description: 'Creates a GitHub repository.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: inputProps.repoUrl,\n          description: inputProps.description,\n          homepage: inputProps.homepage,\n          access: inputProps.access,\n          requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n          bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n          requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n          restrictions: inputProps.restrictions,\n          requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n          requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n          requiredConversationResolution:\n            inputProps.requiredConversationResolution,\n          repoVisibility: inputProps.repoVisibility,\n          deleteBranchOnMerge: inputProps.deleteBranchOnMerge,\n          allowMergeCommit: inputProps.allowMergeCommit,\n          allowSquashMerge: inputProps.allowSquashMerge,\n          squashMergeCommitTitle: inputProps.squashMergeCommitTitle,\n          squashMergeCommitMessage: inputProps.squashMergeCommitMessage,\n          allowRebaseMerge: inputProps.allowRebaseMerge,\n          allowAutoMerge: inputProps.allowAutoMerge,\n          collaborators: inputProps.collaborators,\n          hasProjects: inputProps.hasProjects,\n          hasWiki: inputProps.hasWiki,\n          hasIssues: inputProps.hasIssues,\n          token: inputProps.token,\n          topics: inputProps.topics,\n          repoVariables: inputProps.repoVariables,\n          secrets: inputProps.secrets,\n          oidcCustomization: inputProps.oidcCustomization,\n          requiredCommitSigning: inputProps.requiredCommitSigning,\n          requiredLinearHistory: inputProps.requiredLinearHistory,\n          customProperties: inputProps.customProperties,\n          subscribe: inputProps.subscribe,\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          remoteUrl: outputProps.remoteUrl,\n          repoContentsUrl: outputProps.repoContentsUrl,\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\n        repoVisibility = 'private',\n        deleteBranchOnMerge = false,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        subscribe,\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit(octokitOptions);\n\n      const remoteUrl = await ctx.checkpoint({\n        key: `create.repo.and.topics.${owner}.${repo}`,\n        fn: async () => {\n          const newRepo = await createGithubRepoWithCollaboratorsAndTopics(\n            client,\n            repo,\n            owner,\n            repoVisibility,\n            description,\n            homepage,\n            deleteBranchOnMerge,\n            allowMergeCommit,\n            allowSquashMerge,\n            squashMergeCommitTitle,\n            squashMergeCommitMessage,\n            allowRebaseMerge,\n            allowAutoMerge,\n            access,\n            collaborators,\n            hasProjects,\n            hasWiki,\n            hasIssues,\n            topics,\n            repoVariables,\n            secrets,\n            oidcCustomization,\n            customProperties,\n            subscribe,\n            ctx.logger,\n          );\n          return newRepo.clone_url;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.description","inputProps.homepage","inputProps.access","inputProps.requireCodeOwnerReviews","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.repoVisibility","inputProps.deleteBranchOnMerge","inputProps.allowMergeCommit","inputProps.allowSquashMerge","inputProps.squashMergeCommitTitle","inputProps.squashMergeCommitMessage","inputProps.allowRebaseMerge","inputProps.allowAutoMerge","inputProps.collaborators","inputProps.hasProjects","inputProps.hasWiki","inputProps.hasIssues","inputProps.token","inputProps.topics","inputProps.repoVariables","inputProps.secrets","inputProps.oidcCustomization","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","inputProps.customProperties","inputProps.subscribe","outputProps.remoteUrl","outputProps.repoContentsUrl","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics"],"mappings":";;;;;;;;;;;AAqCO,SAAS,6BAA6B,OAG1C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAEpD,EAAA,OAAOA,yCA4DJ,CAAA;AAAA,IACD,EAAI,EAAA,oBAAA;AAAA,IACJ,WAAa,EAAA,8BAAA;AAAA,cACbC,kCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,SAASC,uBAAW;AAAA,UACpB,aAAaC,2BAAW;AAAA,UACxB,UAAUC,wBAAW;AAAA,UACrB,QAAQC,sBAAW;AAAA,UACnB,yBAAyBC,uCAAW;AAAA,UACpC,6BAA6BC,2CAAW;AAAA,UACxC,8BAA8BC,4CAAW;AAAA,UACzC,cAAcC,4BAAW;AAAA,UACzB,6BAA6BC,2CAAW;AAAA,UACxC,6BAA6BC,2CAAW;AAAA,UACxC,gCACEC,8CAAW;AAAA,UACb,gBAAgBC,8BAAW;AAAA,UAC3B,qBAAqBC,mCAAW;AAAA,UAChC,kBAAkBC,gCAAW;AAAA,UAC7B,kBAAkBC,gCAAW;AAAA,UAC7B,wBAAwBC,sCAAW;AAAA,UACnC,0BAA0BC,wCAAW;AAAA,UACrC,kBAAkBC,gCAAW;AAAA,UAC7B,gBAAgBC,8BAAW;AAAA,UAC3B,eAAeC,6BAAW;AAAA,UAC1B,aAAaC,2BAAW;AAAA,UACxB,SAASC,uBAAW;AAAA,UACpB,WAAWC,yBAAW;AAAA,UACtB,OAAOC,qBAAW;AAAA,UAClB,QAAQC,sBAAW;AAAA,UACnB,eAAeC,6BAAW;AAAA,UAC1B,SAASC,uBAAW;AAAA,UACpB,mBAAmBC,iCAAW;AAAA,UAC9B,uBAAuBC,qCAAW;AAAA,UAClC,uBAAuBC,qCAAW;AAAA,UAClC,kBAAkBC,gCAAW;AAAA,UAC7B,WAAWC;AAAW;AACxB,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,WAAWC,0BAAY;AAAA,UACvB,iBAAiBC;AAAY;AAC/B;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,cAAiB,GAAA,SAAA;AAAA,QACjB,mBAAsB,GAAA,KAAA;AAAA,QACtB,gBAAmB,GAAA,IAAA;AAAA,QACnB,gBAAmB,GAAA,IAAA;AAAA,QACnB,sBAAyB,GAAA,oBAAA;AAAA,QACzB,wBAA2B,GAAA,iBAAA;AAAA,QAC3B,gBAAmB,GAAA,IAAA;AAAA,QACnB,cAAiB,GAAA,KAAA;AAAA,QACjB,aAAA;AAAA,QACA,WAAc,GAAA,KAAA,CAAA;AAAA,QACd,OAAU,GAAA,KAAA,CAAA;AAAA,QACV,SAAY,GAAA,KAAA,CAAA;AAAA,QACZ,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,gBAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAM,MAAA,SAAA,GAAY,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,QACrC,GAAK,EAAA,CAAA,uBAAA,EAA0B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC5C,IAAI,YAAY;AACd,UAAA,MAAM,UAAU,MAAMC,kDAAA;AAAA,YACpB,MAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,YACA,cAAA;AAAA,YACA,WAAA;AAAA,YACA,QAAA;AAAA,YACA,mBAAA;AAAA,YACA,gBAAA;AAAA,YACA,gBAAA;AAAA,YACA,sBAAA;AAAA,YACA,wBAAA;AAAA,YACA,gBAAA;AAAA,YACA,cAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAA;AAAA,YACA,WAAA;AAAA,YACA,OAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAA;AAAA,YACA,OAAA;AAAA,YACA,iBAAA;AAAA,YACA,gBAAA;AAAA,YACA,SAAA;AAAA,YACA,GAAI,CAAA;AAAA,WACN;AACA,UAAA,OAAO,OAAQ,CAAA,SAAA;AAAA;AACjB,OACD,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,aAAa,SAAS,CAAA;AAAA;AACnC,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubRepoPush.cjs.js

@@ -89,34 +89,40 @@ function createGithubRepoPushAction(options) {
       const targetRepo = await client.rest.repos.get({ owner, repo });
       const remoteUrl = targetRepo.data.clone_url;
       const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;
-      const { commitHash } = await helpers.initRepoPushAndProtect(
-        remoteUrl,
-        octokitOptions.auth,
-        ctx.workspacePath,
-        ctx.input.sourcePath,
-        defaultBranch,
-        protectDefaultBranch,
-        protectEnforceAdmins,
-        owner,
-        client,
-        repo,
-        requireCodeOwnerReviews,
-        bypassPullRequestAllowances,
-        requiredApprovingReviewCount,
-        restrictions,
-        requiredStatusCheckContexts,
-        requireBranchesToBeUpToDate,
-        requiredConversationResolution,
-        requireLastPushApproval,
-        config,
-        ctx.logger,
-        gitCommitMessage,
-        gitAuthorName,
-        gitAuthorEmail,
-        dismissStaleReviews,
-        requiredCommitSigning,
-        requiredLinearHistory
-      );
+      const commitHash = await ctx.checkpoint({
+        key: `init.repo.publish.${owner}.${client}.${repo}`,
+        fn: async () => {
+          const { commitHash: hash } = await helpers.initRepoPushAndProtect(
+            remoteUrl,
+            octokitOptions.auth,
+            ctx.workspacePath,
+            ctx.input.sourcePath,
+            defaultBranch,
+            protectDefaultBranch,
+            protectEnforceAdmins,
+            owner,
+            client,
+            repo,
+            requireCodeOwnerReviews,
+            bypassPullRequestAllowances,
+            requiredApprovingReviewCount,
+            restrictions,
+            requiredStatusCheckContexts,
+            requireBranchesToBeUpToDate,
+            requiredConversationResolution,
+            requireLastPushApproval,
+            config,
+            ctx.logger,
+            gitCommitMessage,
+            gitAuthorName,
+            gitAuthorEmail,
+            dismissStaleReviews,
+            requiredCommitSigning,
+            requiredLinearHistory
+          );
+          return hash;
+        }
+      });
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
       ctx.output("commitHash", commitHash);

package/dist/actions/githubRepoPush.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubRepoPush.cjs.js","sources":["../../src/actions/githubRepoPush.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { initRepoPushAndProtect } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoPush.examples';\n\n/**\n * Creates a new action that initializes a git repository of the content in the workspace\n * and publishes it to GitHub.\n *\n * @public\n */\nexport function createGithubRepoPushAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, config, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    description?: string;\n    defaultBranch?: string;\n    protectDefaultBranch?: boolean;\n    protectEnforceAdmins?: boolean;\n    gitCommitMessage?: string;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    requireCodeOwnerReviews?: boolean;\n    dismissStaleReviews?: boolean;\n    bypassPullRequestAllowances?:\n      | {\n          users?: string[];\n          teams?: string[];\n          apps?: string[];\n        }\n      | undefined;\n    requiredApprovingReviewCount?: number;\n    restrictions?:\n      | {\n          users: string[];\n          teams: string[];\n          apps?: string[];\n        }\n      | undefined;\n    requiredStatusCheckContexts?: string[];\n    requireBranchesToBeUpToDate?: boolean;\n    requiredConversationResolution?: boolean;\n    sourcePath?: string;\n    token?: string;\n    requiredCommitSigning?: boolean;\n    requiredLinearHistory?: boolean;\n    requireLastPushApproval?: boolean;\n  }>({\n    id: 'github:repo:push',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: inputProps.repoUrl,\n          requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n          dismissStaleReviews: inputProps.dismissStaleReviews,\n          requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n          bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n          requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n          restrictions: inputProps.restrictions,\n          requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n          requiredConversationResolution:\n            inputProps.requiredConversationResolution,\n          requireLastPushApproval: inputProps.requireLastPushApproval,\n          defaultBranch: inputProps.defaultBranch,\n          protectDefaultBranch: inputProps.protectDefaultBranch,\n          protectEnforceAdmins: inputProps.protectEnforceAdmins,\n          gitCommitMessage: inputProps.gitCommitMessage,\n          gitAuthorName: inputProps.gitAuthorName,\n          gitAuthorEmail: inputProps.gitAuthorEmail,\n          sourcePath: inputProps.sourcePath,\n          token: inputProps.token,\n          requiredCommitSigning: inputProps.requiredCommitSigning,\n          requiredLinearHistory: inputProps.requiredLinearHistory,\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          remoteUrl: outputProps.remoteUrl,\n          repoContentsUrl: outputProps.repoContentsUrl,\n          commitHash: outputProps.commitHash,\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        defaultBranch = 'master',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        gitCommitMessage = 'initial commit',\n        gitAuthorName,\n        gitAuthorEmail,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount = 1,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        token: providedToken,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit(octokitOptions);\n\n      const targetRepo = await client.rest.repos.get({ owner, repo });\n\n      const remoteUrl = targetRepo.data.clone_url;\n      const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;\n\n      const { commitHash } = await initRepoPushAndProtect(\n        remoteUrl,\n        octokitOptions.auth,\n        ctx.workspacePath,\n        ctx.input.sourcePath,\n        defaultBranch,\n        protectDefaultBranch,\n        protectEnforceAdmins,\n        owner,\n        client,\n        repo,\n        requireCodeOwnerReviews,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount,\n        restrictions,\n        requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate,\n        requiredConversationResolution,\n        requireLastPushApproval,\n        config,\n        ctx.logger,\n        gitCommitMessage,\n        gitAuthorName,\n        gitAuthorEmail,\n        dismissStaleReviews,\n        requiredCommitSigning,\n        requiredLinearHistory,\n      );\n\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n      ctx.output('commitHash', commitHash);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.sourcePath","inputProps.token","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","outputProps.remoteUrl","outputProps.repoContentsUrl","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AAuCO,SAAS,2BAA2B,OAIxC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,MAAQ,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAE5D,EAAA,OAAOA,yCAkCJ,CAAA;AAAA,IACD,EAAI,EAAA,kBAAA;AAAA,IACJ,WACE,EAAA,mFAAA;AAAA,cACFC,gCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,SAASC,uBAAW;AAAA,UACpB,yBAAyBC,uCAAW;AAAA,UACpC,qBAAqBC,mCAAW;AAAA,UAChC,6BAA6BC,2CAAW;AAAA,UACxC,6BAA6BC,2CAAW;AAAA,UACxC,8BAA8BC,4CAAW;AAAA,UACzC,cAAcC,4BAAW;AAAA,UACzB,6BAA6BC,2CAAW;AAAA,UACxC,gCACEC,8CAAW;AAAA,UACb,yBAAyBC,uCAAW;AAAA,UACpC,eAAeC,6BAAW;AAAA,UAC1B,sBAAsBC,oCAAW;AAAA,UACjC,sBAAsBC,oCAAW;AAAA,UACjC,kBAAkBC,gCAAW;AAAA,UAC7B,eAAeC,6BAAW;AAAA,UAC1B,gBAAgBC,8BAAW;AAAA,UAC3B,YAAYC,0BAAW;AAAA,UACvB,OAAOC,qBAAW;AAAA,UAClB,uBAAuBC,qCAAW;AAAA,UAClC,uBAAuBC;AAAW;AACpC,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,WAAWC,0BAAY;AAAA,UACvB,iBAAiBC,gCAAY;AAAA,UAC7B,YAAYC;AAAY;AAC1B;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,aAAgB,GAAA,QAAA;AAAA,QAChB,oBAAuB,GAAA,IAAA;AAAA,QACvB,oBAAuB,GAAA,IAAA;AAAA,QACvB,gBAAmB,GAAA,gBAAA;AAAA,QACnB,aAAA;AAAA,QACA,cAAA;AAAA,QACA,uBAA0B,GAAA,KAAA;AAAA,QAC1B,mBAAsB,GAAA,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,4BAA+B,GAAA,CAAA;AAAA,QAC/B,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAA8B,GAAA,IAAA;AAAA,QAC9B,8BAAiC,GAAA,KAAA;AAAA,QACjC,uBAA0B,GAAA,KAAA;AAAA,QAC1B,KAAO,EAAA,aAAA;AAAA,QACP,qBAAwB,GAAA,KAAA;AAAA,QACxB,qBAAwB,GAAA;AAAA,UACtB,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAM,MAAA,UAAA,GAAa,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,GAAI,CAAA,EAAE,KAAO,EAAA,IAAA,EAAM,CAAA;AAE9D,MAAM,MAAA,SAAA,GAAY,WAAW,IAAK,CAAA,SAAA;AAClC,MAAA,MAAM,kBAAkB,CAAG,EAAA,UAAA,CAAW,IAAK,CAAA,QAAQ,SAAS,aAAa,CAAA,CAAA;AAEzE,MAAM,MAAA,EAAE,UAAW,EAAA,GAAI,MAAMC,8BAAA;AAAA,QAC3B,SAAA;AAAA,QACA,cAAe,CAAA,IAAA;AAAA,QACf,GAAI,CAAA,aAAA;AAAA,QACJ,IAAI,KAAM,CAAA,UAAA;AAAA,QACV,aAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,uBAAA;AAAA,QACA,2BAAA;AAAA,QACA,4BAAA;AAAA,QACA,YAAA;AAAA,QACA,2BAAA;AAAA,QACA,2BAAA;AAAA,QACA,8BAAA;AAAA,QACA,uBAAA;AAAA,QACA,MAAA;AAAA,QACA,GAAI,CAAA,MAAA;AAAA,QACJ,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAI,GAAA,CAAA,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAC7C,MAAI,GAAA,CAAA,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubRepoPush.cjs.js","sources":["../../src/actions/githubRepoPush.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { initRepoPushAndProtect } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoPush.examples';\n\n/**\n * Creates a new action that initializes a git repository of the content in the workspace\n * and publishes it to GitHub.\n *\n * @public\n */\nexport function createGithubRepoPushAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, config, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    description?: string;\n    defaultBranch?: string;\n    protectDefaultBranch?: boolean;\n    protectEnforceAdmins?: boolean;\n    gitCommitMessage?: string;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    requireCodeOwnerReviews?: boolean;\n    dismissStaleReviews?: boolean;\n    bypassPullRequestAllowances?:\n      | {\n          users?: string[];\n          teams?: string[];\n          apps?: string[];\n        }\n      | undefined;\n    requiredApprovingReviewCount?: number;\n    restrictions?:\n      | {\n          users: string[];\n          teams: string[];\n          apps?: string[];\n        }\n      | undefined;\n    requiredStatusCheckContexts?: string[];\n    requireBranchesToBeUpToDate?: boolean;\n    requiredConversationResolution?: boolean;\n    sourcePath?: string;\n    token?: string;\n    requiredCommitSigning?: boolean;\n    requiredLinearHistory?: boolean;\n    requireLastPushApproval?: boolean;\n  }>({\n    id: 'github:repo:push',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: inputProps.repoUrl,\n          requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n          dismissStaleReviews: inputProps.dismissStaleReviews,\n          requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n          bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n          requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n          restrictions: inputProps.restrictions,\n          requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n          requiredConversationResolution:\n            inputProps.requiredConversationResolution,\n          requireLastPushApproval: inputProps.requireLastPushApproval,\n          defaultBranch: inputProps.defaultBranch,\n          protectDefaultBranch: inputProps.protectDefaultBranch,\n          protectEnforceAdmins: inputProps.protectEnforceAdmins,\n          gitCommitMessage: inputProps.gitCommitMessage,\n          gitAuthorName: inputProps.gitAuthorName,\n          gitAuthorEmail: inputProps.gitAuthorEmail,\n          sourcePath: inputProps.sourcePath,\n          token: inputProps.token,\n          requiredCommitSigning: inputProps.requiredCommitSigning,\n          requiredLinearHistory: inputProps.requiredLinearHistory,\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          remoteUrl: outputProps.remoteUrl,\n          repoContentsUrl: outputProps.repoContentsUrl,\n          commitHash: outputProps.commitHash,\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        defaultBranch = 'master',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        gitCommitMessage = 'initial commit',\n        gitAuthorName,\n        gitAuthorEmail,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount = 1,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        token: providedToken,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit(octokitOptions);\n\n      const targetRepo = await client.rest.repos.get({ owner, repo });\n\n      const remoteUrl = targetRepo.data.clone_url;\n      const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;\n\n      const commitHash = await ctx.checkpoint({\n        key: `init.repo.publish.${owner}.${client}.${repo}`,\n        fn: async () => {\n          const { commitHash: hash } = await initRepoPushAndProtect(\n            remoteUrl,\n            octokitOptions.auth,\n            ctx.workspacePath,\n            ctx.input.sourcePath,\n            defaultBranch,\n            protectDefaultBranch,\n            protectEnforceAdmins,\n            owner,\n            client,\n            repo,\n            requireCodeOwnerReviews,\n            bypassPullRequestAllowances,\n            requiredApprovingReviewCount,\n            restrictions,\n            requiredStatusCheckContexts,\n            requireBranchesToBeUpToDate,\n            requiredConversationResolution,\n            requireLastPushApproval,\n            config,\n            ctx.logger,\n            gitCommitMessage,\n            gitAuthorName,\n            gitAuthorEmail,\n            dismissStaleReviews,\n            requiredCommitSigning,\n            requiredLinearHistory,\n          );\n          return hash;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n      ctx.output('commitHash', commitHash);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.sourcePath","inputProps.token","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","outputProps.remoteUrl","outputProps.repoContentsUrl","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AAuCO,SAAS,2BAA2B,OAIxC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,MAAQ,EAAA,yBAAA,EAA8B,GAAA,OAAA;AAE5D,EAAA,OAAOA,yCAkCJ,CAAA;AAAA,IACD,EAAI,EAAA,kBAAA;AAAA,IACJ,WACE,EAAA,mFAAA;AAAA,cACFC,gCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,SAASC,uBAAW;AAAA,UACpB,yBAAyBC,uCAAW;AAAA,UACpC,qBAAqBC,mCAAW;AAAA,UAChC,6BAA6BC,2CAAW;AAAA,UACxC,6BAA6BC,2CAAW;AAAA,UACxC,8BAA8BC,4CAAW;AAAA,UACzC,cAAcC,4BAAW;AAAA,UACzB,6BAA6BC,2CAAW;AAAA,UACxC,gCACEC,8CAAW;AAAA,UACb,yBAAyBC,uCAAW;AAAA,UACpC,eAAeC,6BAAW;AAAA,UAC1B,sBAAsBC,oCAAW;AAAA,UACjC,sBAAsBC,oCAAW;AAAA,UACjC,kBAAkBC,gCAAW;AAAA,UAC7B,eAAeC,6BAAW;AAAA,UAC1B,gBAAgBC,8BAAW;AAAA,UAC3B,YAAYC,0BAAW;AAAA,UACvB,OAAOC,qBAAW;AAAA,UAClB,uBAAuBC,qCAAW;AAAA,UAClC,uBAAuBC;AAAW;AACpC,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,WAAWC,0BAAY;AAAA,UACvB,iBAAiBC,gCAAY;AAAA,UAC7B,YAAYC;AAAY;AAC1B;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,aAAgB,GAAA,QAAA;AAAA,QAChB,oBAAuB,GAAA,IAAA;AAAA,QACvB,oBAAuB,GAAA,IAAA;AAAA,QACvB,gBAAmB,GAAA,gBAAA;AAAA,QACnB,aAAA;AAAA,QACA,cAAA;AAAA,QACA,uBAA0B,GAAA,KAAA;AAAA,QAC1B,mBAAsB,GAAA,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,4BAA+B,GAAA,CAAA;AAAA,QAC/B,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAA8B,GAAA,IAAA;AAAA,QAC9B,8BAAiC,GAAA,KAAA;AAAA,QACjC,uBAA0B,GAAA,KAAA;AAAA,QAC1B,KAAO,EAAA,aAAA;AAAA,QACP,qBAAwB,GAAA,KAAA;AAAA,QACxB,qBAAwB,GAAA;AAAA,UACtB,GAAI,CAAA,KAAA;AAER,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA;AAEzC,MAAM,MAAA,UAAA,GAAa,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,GAAI,CAAA,EAAE,KAAO,EAAA,IAAA,EAAM,CAAA;AAE9D,MAAM,MAAA,SAAA,GAAY,WAAW,IAAK,CAAA,SAAA;AAClC,MAAA,MAAM,kBAAkB,CAAG,EAAA,UAAA,CAAW,IAAK,CAAA,QAAQ,SAAS,aAAa,CAAA,CAAA;AAEzE,MAAM,MAAA,UAAA,GAAa,MAAM,GAAA,CAAI,UAAW,CAAA;AAAA,QACtC,KAAK,CAAqB,kBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,MAAM,IAAI,IAAI,CAAA,CAAA;AAAA,QACjD,IAAI,YAAY;AACd,UAAA,MAAM,EAAE,UAAA,EAAY,IAAK,EAAA,GAAI,MAAMC,8BAAA;AAAA,YACjC,SAAA;AAAA,YACA,cAAe,CAAA,IAAA;AAAA,YACf,GAAI,CAAA,aAAA;AAAA,YACJ,IAAI,KAAM,CAAA,UAAA;AAAA,YACV,aAAA;AAAA,YACA,oBAAA;AAAA,YACA,oBAAA;AAAA,YACA,KAAA;AAAA,YACA,MAAA;AAAA,YACA,IAAA;AAAA,YACA,uBAAA;AAAA,YACA,2BAAA;AAAA,YACA,4BAAA;AAAA,YACA,YAAA;AAAA,YACA,2BAAA;AAAA,YACA,2BAAA;AAAA,YACA,8BAAA;AAAA,YACA,uBAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAI,CAAA,MAAA;AAAA,YACJ,gBAAA;AAAA,YACA,aAAA;AAAA,YACA,cAAA;AAAA,YACA,mBAAA;AAAA,YACA,qBAAA;AAAA,YACA;AAAA,WACF;AACA,UAAO,OAAA,IAAA;AAAA;AACT,OACD,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAI,GAAA,CAAA,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAC7C,MAAI,GAAA,CAAA,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubWebhook.cjs.js

@@ -114,17 +114,22 @@ function createGithubWebhookAction(options) {
       }
       try {
         const insecure_ssl = insecureSsl ? "1" : "0";
-        await client.rest.repos.createWebhook({
-          owner,
-          repo,
-          config: {
-            url: webhookUrl,
-            content_type: contentType,
-            secret: webhookSecret,
-            insecure_ssl
-          },
-          events,
-          active
+        await ctx.checkpoint({
+          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,
+          fn: async () => {
+            await client.rest.repos.createWebhook({
+              owner,
+              repo,
+              config: {
+                url: webhookUrl,
+                content_type: contentType,
+                secret: webhookSecret,
+                insecure_ssl
+              },
+              events,
+              active
+            });
+          }
         });
         ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);
       } catch (e) {

package/dist/actions/githubWebhook.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, defaultWebhookSecret, githubCredentialsProvider } =\n    options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction<{\n    repoUrl: string;\n    webhookUrl: string;\n    webhookSecret?: string;\n    events?: string[];\n    active?: boolean;\n    contentType?: 'form' | 'json';\n    insecureSsl?: boolean;\n    token?: string;\n  }>({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'webhookUrl'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          webhookUrl: {\n            title: 'Webhook URL',\n            description: 'The URL to which the payloads will be delivered',\n            type: 'string',\n          },\n          webhookSecret: {\n            title: 'Webhook Secret',\n            description:\n              'Webhook secret value. The default can be provided internally in action creation',\n            type: 'string',\n          },\n          events: {\n            title: 'Triggering Events',\n            description:\n              'Determines what events the hook is triggered for. Default: `[push]`',\n            type: 'array',\n            default: ['push'],\n            oneOf: [\n              {\n                items: {\n                  type: 'string',\n                  enum: eventNames,\n                },\n              },\n              {\n                items: {\n                  type: 'string',\n                  const: '*',\n                },\n              },\n            ],\n          },\n          active: {\n            title: 'Active',\n            type: 'boolean',\n            default: true,\n            description:\n              'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n          },\n          contentType: {\n            title: 'Content Type',\n            type: 'string',\n            enum: ['form', 'json'],\n            default: 'form',\n            description:\n              'The media type used to serialize the payloads. The default is `form`',\n          },\n          insecureSsl: {\n            title: 'Insecure SSL',\n            type: 'boolean',\n            default: false,\n            description:\n              'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description:\n              'The `GITHUB_TOKEN` to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          credentialsProvider: githubCredentialsProvider,\n          host,\n          owner,\n          repo,\n          token: providedToken,\n        }),\n      );\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n        await client.rest.repos.createWebhook({\n          owner,\n          repo,\n          config: {\n            url: webhookUrl,\n            content_type: contentType,\n            secret: webhookSecret,\n            insecure_ssl,\n          },\n          events,\n          active,\n        });\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions","assertError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAIvC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,oBAAsB,EAAA,yBAAA,EAC1C,GAAA,OAAA;AAEF,EAAM,MAAA,UAAA,GAAaA,2BAAkB,MAAO,CAAA,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,gBAAA;AAAA,IACJ,WAAa,EAAA,6CAAA;AAAA,cACbC,+BAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAA,EAAW,YAAY,CAAA;AAAA,QAClC,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,iDAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,aAAe,EAAA;AAAA,YACb,KAAO,EAAA,gBAAA;AAAA,YACP,WACE,EAAA,iFAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA,qEAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,OAAA,EAAS,CAAC,MAAM,CAAA;AAAA,YAChB,KAAO,EAAA;AAAA,cACL;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,IAAM,EAAA;AAAA;AACR,eACF;AAAA,cACA;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,KAAO,EAAA;AAAA;AACT;AACF;AACF,WACF;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,IAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,IAAA,EAAM,CAAC,MAAA,EAAQ,MAAM,CAAA;AAAA,YACrB,OAAS,EAAA,MAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,KAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAgB,GAAA,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAS,GAAA,IAAA;AAAA,QACT,WAAc,GAAA,MAAA;AAAA,QACd,WAAc,GAAA,KAAA;AAAA,QACd,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAE,CAAA,CAAA;AACpE,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,sBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,IAAA;AAAA,UACA,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAO,EAAA;AAAA,SACR;AAAA,OACH;AAGA,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAM,MAAA,YAAA,GAAe,cAAc,GAAM,GAAA,GAAA;AACzC,QAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UACpC,KAAA;AAAA,UACA,IAAA;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,GAAK,EAAA,UAAA;AAAA,YACL,YAAc,EAAA,WAAA;AAAA,YACd,MAAQ,EAAA,aAAA;AAAA,YACR;AAAA,WACF;AAAA,UACA,MAAA;AAAA,UACA;AAAA,SACD,CAAA;AACD,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAY,SAAA,EAAA,UAAU,CAAwB,sBAAA,CAAA,CAAA;AAAA,eACvD,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,2BAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SACzE;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, defaultWebhookSecret, githubCredentialsProvider } =\n    options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction<{\n    repoUrl: string;\n    webhookUrl: string;\n    webhookSecret?: string;\n    events?: string[];\n    active?: boolean;\n    contentType?: 'form' | 'json';\n    insecureSsl?: boolean;\n    token?: string;\n  }>({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'webhookUrl'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          webhookUrl: {\n            title: 'Webhook URL',\n            description: 'The URL to which the payloads will be delivered',\n            type: 'string',\n          },\n          webhookSecret: {\n            title: 'Webhook Secret',\n            description:\n              'Webhook secret value. The default can be provided internally in action creation',\n            type: 'string',\n          },\n          events: {\n            title: 'Triggering Events',\n            description:\n              'Determines what events the hook is triggered for. Default: `[push]`',\n            type: 'array',\n            default: ['push'],\n            oneOf: [\n              {\n                items: {\n                  type: 'string',\n                  enum: eventNames,\n                },\n              },\n              {\n                items: {\n                  type: 'string',\n                  const: '*',\n                },\n              },\n            ],\n          },\n          active: {\n            title: 'Active',\n            type: 'boolean',\n            default: true,\n            description:\n              'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n          },\n          contentType: {\n            title: 'Content Type',\n            type: 'string',\n            enum: ['form', 'json'],\n            default: 'form',\n            description:\n              'The media type used to serialize the payloads. The default is `form`',\n          },\n          insecureSsl: {\n            title: 'Insecure SSL',\n            type: 'boolean',\n            default: false,\n            description:\n              'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description:\n              'The `GITHUB_TOKEN` to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          credentialsProvider: githubCredentialsProvider,\n          host,\n          owner,\n          repo,\n          token: providedToken,\n        }),\n      );\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n\n        await ctx.checkpoint({\n          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,\n          fn: async () => {\n            await client.rest.repos.createWebhook({\n              owner,\n              repo,\n              config: {\n                url: webhookUrl,\n                content_type: contentType,\n                secret: webhookSecret,\n                insecure_ssl,\n              },\n              events,\n              active,\n            });\n          },\n        });\n\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions","assertError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAIvC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,oBAAsB,EAAA,yBAAA,EAC1C,GAAA,OAAA;AAEF,EAAM,MAAA,UAAA,GAAaA,2BAAkB,MAAO,CAAA,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,gBAAA;AAAA,IACJ,WAAa,EAAA,6CAAA;AAAA,cACbC,+BAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAA,EAAW,YAAY,CAAA;AAAA,QAClC,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,iDAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,aAAe,EAAA;AAAA,YACb,KAAO,EAAA,gBAAA;AAAA,YACP,WACE,EAAA,iFAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA,qEAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,OAAA,EAAS,CAAC,MAAM,CAAA;AAAA,YAChB,KAAO,EAAA;AAAA,cACL;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,IAAM,EAAA;AAAA;AACR,eACF;AAAA,cACA;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,KAAO,EAAA;AAAA;AACT;AACF;AACF,WACF;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,IAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,IAAA,EAAM,CAAC,MAAA,EAAQ,MAAM,CAAA;AAAA,YACrB,OAAS,EAAA,MAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,KAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAgB,GAAA,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAS,GAAA,IAAA;AAAA,QACT,WAAc,GAAA,MAAA;AAAA,QACd,WAAc,GAAA,KAAA;AAAA,QACd,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAE,CAAA,CAAA;AACpE,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,sBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,IAAA;AAAA,UACA,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAO,EAAA;AAAA,SACR;AAAA,OACH;AAGA,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAM,MAAA,YAAA,GAAe,cAAc,GAAM,GAAA,GAAA;AAEzC,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,KAAK,CAAmB,gBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,cACpC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAQ,EAAA;AAAA,gBACN,GAAK,EAAA,UAAA;AAAA,gBACL,YAAc,EAAA,WAAA;AAAA,gBACd,MAAQ,EAAA,aAAA;AAAA,gBACR;AAAA,eACF;AAAA,cACA,MAAA;AAAA,cACA;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAY,SAAA,EAAA,UAAU,CAAwB,sBAAA,CAAA,CAAA;AAAA,eACvD,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,2BAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SACzE;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-github",
-  "version": "0.6.1-next.2",
+  "version": "0.6.1",
   "description": "The github module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "backend-plugin-module",
@@ -43,13 +43,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
-    "@backstage/catalog-client": "1.9.1",
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.16.2-next.0",
-    "@backstage/plugin-scaffolder-node": "0.8.0-next.2",
+    "@backstage/backend-plugin-api": "^1.2.1",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.16.2",
+    "@backstage/plugin-scaffolder-node": "^0.8.0",
+    "@backstage/types": "^1.2.1",
     "@octokit/webhooks": "^10.9.2",
     "libsodium-wrappers": "^0.7.11",
     "octokit": "^3.0.0",
@@ -57,9 +58,9 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.2",
-    "@backstage/cli": "0.31.0-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.2.0-next.2",
+    "@backstage/backend-test-utils": "^1.3.1",
+    "@backstage/cli": "^0.31.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.2.0",
     "@types/libsodium-wrappers": "^0.7.10",
     "fs-extra": "^11.2.0",
     "jsonschema": "^1.2.6"