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

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @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
+
+- 9391f58: Pass `undefined` to some parameters for `createOrUpdateEnvironment` as these values are not always supported in different plans of GitHub
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.8.0-next.2
+  - @backstage/integration@1.16.2-next.0
+  - @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
+
 ## 0.6.1-next.1
 
 ### 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 ?? null,
-        wait_timer: waitTimer ?? 0,
-        prevent_self_review: preventSelfReview ?? false,
-        reviewers: githubReviewers.length ? githubReviewers : null
-      });
-      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 ?? null,\n        wait_timer: waitTimer ?? 0,\n        prevent_self_review: preventSelfReview ?? false,\n        reviewers: githubReviewers.length ? githubReviewers : null,\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,IAAA;AAAA,QACpD,YAAY,SAAa,IAAA,CAAA;AAAA,QACzB,qBAAqB,iBAAqB,IAAA,KAAA;AAAA,QAC1C,SAAA,EAAW,eAAgB,CAAA,MAAA,GAAS,eAAkB,GAAA;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}`,