@backstage/plugin-scaffolder-backend-module-github 0.9.13-next.0 → 0.9.14-next.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.9.14-next.1
+
+### Patch Changes
+
+- bbba6b5: Added support for requiring user-provided credentials for GitHub mutation actions when `scaffolder.requireScmUserCredentials` is enabled.
+- Updated dependencies
+  - @backstage/integration@2.1.2-next.0
+  - @backstage/plugin-scaffolder-node@0.13.7-next.1
+  - @backstage/backend-plugin-api@1.10.1-next.0
+  - @backstage/plugin-catalog-node@2.2.5-next.0
+
 ## 0.9.13-next.0
 
 ### Patch Changes

package/dist/actions/github.cjs.js

@@ -10,7 +10,12 @@ var outputProperties = require('./outputProperties.cjs.js');
 var github_examples = require('./github.examples.cjs.js');
 
 function createPublishGithubAction(options) {
-  const { integrations, config, githubCredentialsProvider } = options;
+  const {
+    integrations,
+    config,
+    githubCredentialsProvider,
+    requireScmUserCredentials
+  } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
@@ -116,6 +121,7 @@ function createPublishGithubAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         token: providedToken,
         host,

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

@@ -1 +1 @@
-{"version":3,"file":"github.cjs.js","sources":["../../src/actions/github.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 {\n  createGithubRepoWithCollaboratorsAndTopics,\n  initRepoPushAndProtect,\n} from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './github.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 createPublishGithubAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, config, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'publish:github',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        description: inputProps.description,\n        homepage: inputProps.homepage,\n        access: inputProps.access,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        restrictions: inputProps.restrictions,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        repoVisibility: inputProps.repoVisibility,\n        defaultBranch: inputProps.defaultBranch,\n        protectDefaultBranch: inputProps.protectDefaultBranch,\n        protectEnforceAdmins: inputProps.protectEnforceAdmins,\n        deleteBranchOnMerge: inputProps.deleteBranchOnMerge,\n        gitCommitMessage: inputProps.gitCommitMessage,\n        gitAuthorName: inputProps.gitAuthorName,\n        gitAuthorEmail: inputProps.gitAuthorEmail,\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        allowUpdateBranch: inputProps.allowUpdateBranch,\n        sourcePath: inputProps.sourcePath,\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      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n        commitHash: outputProps.commitHash,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\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        repoVisibility = 'private',\n        defaultBranch = 'main',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        deleteBranchOnMerge = false,\n        gitCommitMessage,\n        gitAuthorName,\n        gitAuthorEmail,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        allowUpdateBranch = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        token: providedToken,\n        customProperties,\n        subscribe = false,\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      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      const { remoteUrl, repoContentsUrl } = await ctx.checkpoint({\n        key: `create.github.repo.${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            allowUpdateBranch,\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          return {\n            remoteUrl: newRepo.clone_url,\n            repoContentsUrl: `${newRepo.html_url}/blob/${defaultBranch}`,\n          };\n        },\n      });\n\n      const commitResult = 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('commitHash', commitResult?.commitHash);\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.description","inputProps.homepage","inputProps.access","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.repoVisibility","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.deleteBranchOnMerge","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.allowMergeCommit","inputProps.allowSquashMerge","inputProps.squashMergeCommitTitle","inputProps.squashMergeCommitMessage","inputProps.allowRebaseMerge","inputProps.allowAutoMerge","inputProps.allowUpdateBranch","inputProps.sourcePath","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","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AA0CO,SAAS,0BAA0B,OAAA,EAIvC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,MAAA,EAAQ,yBAAA,EAA0B,GAAI,OAAA;AAE5D,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,gBAAA;AAAA,IACJ,WAAA,EACE,mFAAA;AAAA,cACFC,wBAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,aAAaC,2BAAW;AAAA,QACxB,UAAUC,wBAAW;AAAA,QACrB,QAAQC,sBAAW;AAAA,QACnB,6BAA6BC,2CAAW;AAAA,QACxC,8BAA8BC,4CAAW;AAAA,QACzC,cAAcC,4BAAW;AAAA,QACzB,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,gBAAgBC,8BAAW;AAAA,QAC3B,eAAeC,6BAAW;AAAA,QAC1B,sBAAsBC,oCAAW;AAAA,QACjC,sBAAsBC,oCAAW;AAAA,QACjC,qBAAqBC,mCAAW;AAAA,QAChC,kBAAkBC,gCAAW;AAAA,QAC7B,eAAeC,6BAAW;AAAA,QAC1B,gBAAgBC,8BAAW;AAAA,QAC3B,kBAAkBC,gCAAW;AAAA,QAC7B,kBAAkBC,gCAAW;AAAA,QAC7B,wBAAwBC,sCAAW;AAAA,QACnC,0BAA0BC,wCAAW;AAAA,QACrC,kBAAkBC,gCAAW;AAAA,QAC7B,gBAAgBC,8BAAW;AAAA,QAC3B,mBAAmBC,iCAAW;AAAA,QAC9B,YAAYC,0BAAW;AAAA,QACvB,eAAeC,6BAAW;AAAA,QAC1B,aAAaC,2BAAW;AAAA,QACxB,SAASC,uBAAW;AAAA,QACpB,WAAWC,yBAAW;AAAA,QACtB,OAAOC,qBAAW;AAAA,QAClB,QAAQC,sBAAW;AAAA,QACnB,eAAeC,6BAAW;AAAA,QAC1B,SAASC,uBAAW;AAAA,QACpB,mBAAmBC,iCAAW;AAAA,QAC9B,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC,qCAAW;AAAA,QAClC,kBAAkBC,gCAAW;AAAA,QAC7B,WAAWC;AAAW,OACxB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,WAAWC,0BAAY;AAAA,QACvB,iBAAiBC,gCAAY;AAAA,QAC7B,YAAYC;AAAY;AAC1B,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,uBAAA,GAA0B,KAAA;AAAA,QAC1B,mBAAA,GAAsB,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,4BAAA,GAA+B,CAAA;AAAA,QAC/B,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAAA,GAA8B,IAAA;AAAA,QAC9B,8BAAA,GAAiC,KAAA;AAAA,QACjC,uBAAA,GAA0B,KAAA;AAAA,QAC1B,cAAA,GAAiB,SAAA;AAAA,QACjB,aAAA,GAAgB,MAAA;AAAA,QAChB,oBAAA,GAAuB,IAAA;AAAA,QACvB,oBAAA,GAAuB,IAAA;AAAA,QACvB,mBAAA,GAAsB,KAAA;AAAA,QACtB,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,gBAAA,GAAmB,IAAA;AAAA,QACnB,gBAAA,GAAmB,IAAA;AAAA,QACnB,sBAAA,GAAyB,oBAAA;AAAA,QACzB,wBAAA,GAA2B,iBAAA;AAAA,QAC3B,gBAAA,GAAmB,IAAA;AAAA,QACnB,cAAA,GAAiB,KAAA;AAAA,QACjB,iBAAA,GAAoB,KAAA;AAAA,QACpB,aAAA;AAAA,QACA,WAAA,GAAc,MAAA;AAAA,QACd,OAAA,GAAU,MAAA;AAAA,QACV,SAAA,GAAY,MAAA;AAAA,QACZ,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,gBAAA;AAAA,QACA,SAAA,GAAY,KAAA;AAAA,QACZ,qBAAA,GAAwB,KAAA;AAAA,QACxB,qBAAA,GAAwB;AAAA,UACtB,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,EAAE,SAAA,EAAW,eAAA,EAAgB,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,QAC1D,GAAA,EAAK,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACxC,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,iBAAA;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,GAAA,CAAI;AAAA,WACN;AAEA,UAAA,OAAO;AAAA,YACL,WAAW,OAAA,CAAQ,SAAA;AAAA,YACnB,eAAA,EAAiB,CAAA,EAAG,OAAA,CAAQ,QAAQ,SAAS,aAAa,CAAA;AAAA,WAC5D;AAAA,QACF;AAAA,OACD,CAAA;AAED,MAAA,MAAM,eAAe,MAAMC,8BAAA;AAAA,QACzB,SAAA;AAAA,QACA,cAAA,CAAe,IAAA;AAAA,QACf,GAAA,CAAI,aAAA;AAAA,QACJ,IAAI,KAAA,CAAM,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,GAAA,CAAI,MAAA;AAAA,QACJ,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAA,CAAO,YAAA,EAAc,YAAA,EAAc,UAAU,CAAA;AACjD,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAA,GAAA,CAAI,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAAA,IAC/C;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"github.cjs.js","sources":["../../src/actions/github.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 {\n  createGithubRepoWithCollaboratorsAndTopics,\n  initRepoPushAndProtect,\n} from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './github.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 createPublishGithubAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const {\n    integrations,\n    config,\n    githubCredentialsProvider,\n    requireScmUserCredentials,\n  } = options;\n\n  return createTemplateAction({\n    id: 'publish:github',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        description: inputProps.description,\n        homepage: inputProps.homepage,\n        access: inputProps.access,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        restrictions: inputProps.restrictions,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        repoVisibility: inputProps.repoVisibility,\n        defaultBranch: inputProps.defaultBranch,\n        protectDefaultBranch: inputProps.protectDefaultBranch,\n        protectEnforceAdmins: inputProps.protectEnforceAdmins,\n        deleteBranchOnMerge: inputProps.deleteBranchOnMerge,\n        gitCommitMessage: inputProps.gitCommitMessage,\n        gitAuthorName: inputProps.gitAuthorName,\n        gitAuthorEmail: inputProps.gitAuthorEmail,\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        allowUpdateBranch: inputProps.allowUpdateBranch,\n        sourcePath: inputProps.sourcePath,\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      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n        commitHash: outputProps.commitHash,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\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        repoVisibility = 'private',\n        defaultBranch = 'main',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        deleteBranchOnMerge = false,\n        gitCommitMessage,\n        gitAuthorName,\n        gitAuthorEmail,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        allowUpdateBranch = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        token: providedToken,\n        customProperties,\n        subscribe = false,\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        requireScmUserCredentials,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      const { remoteUrl, repoContentsUrl } = await ctx.checkpoint({\n        key: `create.github.repo.${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            allowUpdateBranch,\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          return {\n            remoteUrl: newRepo.clone_url,\n            repoContentsUrl: `${newRepo.html_url}/blob/${defaultBranch}`,\n          };\n        },\n      });\n\n      const commitResult = 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('commitHash', commitResult?.commitHash);\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.description","inputProps.homepage","inputProps.access","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.repoVisibility","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.deleteBranchOnMerge","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.allowMergeCommit","inputProps.allowSquashMerge","inputProps.squashMergeCommitTitle","inputProps.squashMergeCommitMessage","inputProps.allowRebaseMerge","inputProps.allowAutoMerge","inputProps.allowUpdateBranch","inputProps.sourcePath","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","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AA0CO,SAAS,0BAA0B,OAAA,EAKvC;AACD,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,MAAA;AAAA,IACA,yBAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,gBAAA;AAAA,IACJ,WAAA,EACE,mFAAA;AAAA,cACFC,wBAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,aAAaC,2BAAW;AAAA,QACxB,UAAUC,wBAAW;AAAA,QACrB,QAAQC,sBAAW;AAAA,QACnB,6BAA6BC,2CAAW;AAAA,QACxC,8BAA8BC,4CAAW;AAAA,QACzC,cAAcC,4BAAW;AAAA,QACzB,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,gBAAgBC,8BAAW;AAAA,QAC3B,eAAeC,6BAAW;AAAA,QAC1B,sBAAsBC,oCAAW;AAAA,QACjC,sBAAsBC,oCAAW;AAAA,QACjC,qBAAqBC,mCAAW;AAAA,QAChC,kBAAkBC,gCAAW;AAAA,QAC7B,eAAeC,6BAAW;AAAA,QAC1B,gBAAgBC,8BAAW;AAAA,QAC3B,kBAAkBC,gCAAW;AAAA,QAC7B,kBAAkBC,gCAAW;AAAA,QAC7B,wBAAwBC,sCAAW;AAAA,QACnC,0BAA0BC,wCAAW;AAAA,QACrC,kBAAkBC,gCAAW;AAAA,QAC7B,gBAAgBC,8BAAW;AAAA,QAC3B,mBAAmBC,iCAAW;AAAA,QAC9B,YAAYC,0BAAW;AAAA,QACvB,eAAeC,6BAAW;AAAA,QAC1B,aAAaC,2BAAW;AAAA,QACxB,SAASC,uBAAW;AAAA,QACpB,WAAWC,yBAAW;AAAA,QACtB,OAAOC,qBAAW;AAAA,QAClB,QAAQC,sBAAW;AAAA,QACnB,eAAeC,6BAAW;AAAA,QAC1B,SAASC,uBAAW;AAAA,QACpB,mBAAmBC,iCAAW;AAAA,QAC9B,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC,qCAAW;AAAA,QAClC,kBAAkBC,gCAAW;AAAA,QAC7B,WAAWC;AAAW,OACxB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,WAAWC,0BAAY;AAAA,QACvB,iBAAiBC,gCAAY;AAAA,QAC7B,YAAYC;AAAY;AAC1B,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,uBAAA,GAA0B,KAAA;AAAA,QAC1B,mBAAA,GAAsB,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,4BAAA,GAA+B,CAAA;AAAA,QAC/B,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAAA,GAA8B,IAAA;AAAA,QAC9B,8BAAA,GAAiC,KAAA;AAAA,QACjC,uBAAA,GAA0B,KAAA;AAAA,QAC1B,cAAA,GAAiB,SAAA;AAAA,QACjB,aAAA,GAAgB,MAAA;AAAA,QAChB,oBAAA,GAAuB,IAAA;AAAA,QACvB,oBAAA,GAAuB,IAAA;AAAA,QACvB,mBAAA,GAAsB,KAAA;AAAA,QACtB,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,gBAAA,GAAmB,IAAA;AAAA,QACnB,gBAAA,GAAmB,IAAA;AAAA,QACnB,sBAAA,GAAyB,oBAAA;AAAA,QACzB,wBAAA,GAA2B,iBAAA;AAAA,QAC3B,gBAAA,GAAmB,IAAA;AAAA,QACnB,cAAA,GAAiB,KAAA;AAAA,QACjB,iBAAA,GAAoB,KAAA;AAAA,QACpB,aAAA;AAAA,QACA,WAAA,GAAc,MAAA;AAAA,QACd,OAAA,GAAU,MAAA;AAAA,QACV,SAAA,GAAY,MAAA;AAAA,QACZ,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,gBAAA;AAAA,QACA,SAAA,GAAY,KAAA;AAAA,QACZ,qBAAA,GAAwB,KAAA;AAAA,QACxB,qBAAA,GAAwB;AAAA,UACtB,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,EAAE,SAAA,EAAW,eAAA,EAAgB,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,QAC1D,GAAA,EAAK,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACxC,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,iBAAA;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,GAAA,CAAI;AAAA,WACN;AAEA,UAAA,OAAO;AAAA,YACL,WAAW,OAAA,CAAQ,SAAA;AAAA,YACnB,eAAA,EAAiB,CAAA,EAAG,OAAA,CAAQ,QAAQ,SAAS,aAAa,CAAA;AAAA,WAC5D;AAAA,QACF;AAAA,OACD,CAAA;AAED,MAAA,MAAM,eAAe,MAAMC,8BAAA;AAAA,QACzB,SAAA;AAAA,QACA,cAAA,CAAe,IAAA;AAAA,QACf,GAAA,CAAI,aAAA;AAAA,QACJ,IAAI,KAAA,CAAM,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,GAAA,CAAI,MAAA;AAAA,QACJ,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,GAAA,CAAI,MAAA,CAAO,YAAA,EAAc,YAAA,EAAc,UAAU,CAAA;AACjD,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAA,GAAA,CAAI,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAAA,IAC/C;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubActionsDispatch.cjs.js

@@ -7,7 +7,7 @@ var util = require('../util.cjs.js');
 var githubActionsDispatch_examples = require('./githubActionsDispatch.examples.cjs.js');
 
 function createGithubActionsDispatchAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
@@ -57,6 +57,7 @@ function createGithubActionsDispatchAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         host,
         owner,
         repo,

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

@@ -1 +1 @@
-{"version":3,"file":"githubActionsDispatch.cjs.js","sources":["../../src/actions/githubActionsDispatch.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, toError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubActionsDispatch.examples';\n\n/**\n * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.\n * @public\n */\nexport function createGithubActionsDispatchAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:actions:dispatch',\n    description:\n      'Dispatches a GitHub Action workflow for a given branch or tag',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        workflowId: z =>\n          z.string({\n            description: 'The GitHub Action Workflow filename',\n          }),\n        branchOrTagName: z =>\n          z.string({\n            description:\n              'The git branch or tag name used to dispatch the workflow',\n          }),\n        workflowInputs: z =>\n          z\n            .record(z.string(), {\n              description:\n                'Inputs keys and values to send to GitHub Action configured on the workflow file. The maximum number of properties is 25.',\n            })\n            .optional(),\n        returnWorkflowRunDetails: z =>\n          z\n            .boolean({\n              description:\n                'If true, returns the workflow run ID and URLs as action outputs.',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        workflowRunId: z =>\n          z.number({ description: 'The triggered workflow run ID' }).optional(),\n        workflowRunUrl: z =>\n          z.string({ description: 'API URL of the workflow run' }).optional(),\n        workflowRunHtmlUrl: z =>\n          z.string({ description: 'HTML URL of the workflow run' }).optional(),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        workflowId,\n        branchOrTagName,\n        workflowInputs,\n        returnWorkflowRunDetails,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(\n        `Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`,\n      );\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        host,\n        owner,\n        repo,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      try {\n        const runDetails = await ctx.checkpoint({\n          key: `create.workflow.dispatch.${owner}.${repo}.${workflowId}`,\n          fn: async () => {\n            const dispatchParams = {\n              owner,\n              repo,\n              workflow_id: workflowId,\n              ref: branchOrTagName,\n              inputs: workflowInputs,\n              ...(returnWorkflowRunDetails ? { return_run_details: true } : {}),\n            };\n            const response = await client.rest.actions.createWorkflowDispatch(\n              dispatchParams,\n            );\n\n            ctx.logger.info(`Workflow ${workflowId} dispatched successfully`);\n\n            if (returnWorkflowRunDetails && response.data) {\n              // GitHub's API returns 200 with run details when return_run_details is true.\n              // @octokit/openapi-types still types this as OctokitResponse<never, 204> because\n              // it hasn't picked up the updated GitHub OpenAPI spec yet.\n              // See: https://github.blog/changelog/2026-02-19-workflow-dispatch-api-now-returns-run-ids/\n              // This cast can be removed once @octokit/openapi-types includes the updated spec.\n              // Note: only supported on GitHub.com and GitHub Enterprise Cloud, not GitHub Enterprise Server\n              const data = response.data as unknown as {\n                workflow_run_id: number;\n                run_url: string;\n                html_url: string;\n              };\n\n              return {\n                workflowRunId: data.workflow_run_id,\n                workflowRunUrl: data.run_url,\n                workflowRunHtmlUrl: data.html_url,\n              };\n            }\n            return null;\n          },\n        });\n\n        if (runDetails) {\n          ctx.output('workflowRunId', runDetails.workflowRunId);\n          ctx.output('workflowRunUrl', runDetails.workflowRunUrl);\n          ctx.output('workflowRunHtmlUrl', runDetails.workflowRunHtmlUrl);\n\n          if (runDetails.workflowRunHtmlUrl) {\n            ctx.logger.info(\n              `Workflow run url: ${runDetails.workflowRunHtmlUrl}`,\n            );\n          }\n        }\n      } catch (e) {\n        const error = toError(e);\n        ctx.logger.warn(\n          `Failed: dispatching workflow '${workflowId}' on repo: '${repo}', ${error.message}`,\n        );\n        throw error;\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,kCAAkC,OAAA,EAG/C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EACE,+DAAA;AAAA,cACFC,uCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,eAAA,EAAiB,CAAA,CAAA,KACf,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,gBAAgB,CAAA,CAAA,KACd,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,wBAAA,EAA0B,CAAA,CAAA,KACxB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,aAAA,EAAe,OACb,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,+BAAA,EAAiC,CAAA,CAAE,QAAA,EAAS;AAAA,QACtE,cAAA,EAAgB,OACd,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,6BAAA,EAA+B,CAAA,CAAE,QAAA,EAAS;AAAA,QACpE,kBAAA,EAAoB,OAClB,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,8BAAA,EAAgC,CAAA,CAAE,QAAA;AAAS;AACvE,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,eAAA;AAAA,QACA,cAAA;AAAA,QACA,wBAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACT,CAAA,qBAAA,EAAwB,UAAU,CAAA,UAAA,EAAa,OAAO,OAAO,eAAe,CAAA;AAAA,OAC9E;AAEA,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,KAAA,EAAO;AAAA,OACR,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI;AACF,QAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACtC,KAAK,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UAC5D,IAAI,YAAY;AACd,YAAA,MAAM,cAAA,GAAiB;AAAA,cACrB,KAAA;AAAA,cACA,IAAA;AAAA,cACA,WAAA,EAAa,UAAA;AAAA,cACb,GAAA,EAAK,eAAA;AAAA,cACL,MAAA,EAAQ,cAAA;AAAA,cACR,GAAI,wBAAA,GAA2B,EAAE,kBAAA,EAAoB,IAAA,KAAS;AAAC,aACjE;AACA,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,sBAAA;AAAA,cACzC;AAAA,aACF;AAEA,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,UAAU,CAAA,wBAAA,CAA0B,CAAA;AAEhE,YAAA,IAAI,wBAAA,IAA4B,SAAS,IAAA,EAAM;AAO7C,cAAA,MAAM,OAAO,QAAA,CAAS,IAAA;AAMtB,cAAA,OAAO;AAAA,gBACL,eAAe,IAAA,CAAK,eAAA;AAAA,gBACpB,gBAAgB,IAAA,CAAK,OAAA;AAAA,gBACrB,oBAAoB,IAAA,CAAK;AAAA,eAC3B;AAAA,YACF;AACA,YAAA,OAAO,IAAA;AAAA,UACT;AAAA,SACD,CAAA;AAED,QAAA,IAAI,UAAA,EAAY;AACd,UAAA,GAAA,CAAI,MAAA,CAAO,eAAA,EAAiB,UAAA,CAAW,aAAa,CAAA;AACpD,UAAA,GAAA,CAAI,MAAA,CAAO,gBAAA,EAAkB,UAAA,CAAW,cAAc,CAAA;AACtD,UAAA,GAAA,CAAI,MAAA,CAAO,oBAAA,EAAsB,UAAA,CAAW,kBAAkB,CAAA;AAE9D,UAAA,IAAI,WAAW,kBAAA,EAAoB;AACjC,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,cACT,CAAA,kBAAA,EAAqB,WAAW,kBAAkB,CAAA;AAAA,aACpD;AAAA,UACF;AAAA,QACF;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,iCAAiC,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,MAAM,OAAO,CAAA;AAAA,SACnF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubActionsDispatch.cjs.js","sources":["../../src/actions/githubActionsDispatch.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, toError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubActionsDispatch.examples';\n\n/**\n * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.\n * @public\n */\nexport function createGithubActionsDispatchAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:actions:dispatch',\n    description:\n      'Dispatches a GitHub Action workflow for a given branch or tag',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        workflowId: z =>\n          z.string({\n            description: 'The GitHub Action Workflow filename',\n          }),\n        branchOrTagName: z =>\n          z.string({\n            description:\n              'The git branch or tag name used to dispatch the workflow',\n          }),\n        workflowInputs: z =>\n          z\n            .record(z.string(), {\n              description:\n                'Inputs keys and values to send to GitHub Action configured on the workflow file. The maximum number of properties is 25.',\n            })\n            .optional(),\n        returnWorkflowRunDetails: z =>\n          z\n            .boolean({\n              description:\n                'If true, returns the workflow run ID and URLs as action outputs.',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        workflowRunId: z =>\n          z.number({ description: 'The triggered workflow run ID' }).optional(),\n        workflowRunUrl: z =>\n          z.string({ description: 'API URL of the workflow run' }).optional(),\n        workflowRunHtmlUrl: z =>\n          z.string({ description: 'HTML URL of the workflow run' }).optional(),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        workflowId,\n        branchOrTagName,\n        workflowInputs,\n        returnWorkflowRunDetails,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(\n        `Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`,\n      );\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        requireScmUserCredentials,\n        host,\n        owner,\n        repo,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      try {\n        const runDetails = await ctx.checkpoint({\n          key: `create.workflow.dispatch.${owner}.${repo}.${workflowId}`,\n          fn: async () => {\n            const dispatchParams = {\n              owner,\n              repo,\n              workflow_id: workflowId,\n              ref: branchOrTagName,\n              inputs: workflowInputs,\n              ...(returnWorkflowRunDetails ? { return_run_details: true } : {}),\n            };\n            const response = await client.rest.actions.createWorkflowDispatch(\n              dispatchParams,\n            );\n\n            ctx.logger.info(`Workflow ${workflowId} dispatched successfully`);\n\n            if (returnWorkflowRunDetails && response.data) {\n              // GitHub's API returns 200 with run details when return_run_details is true.\n              // @octokit/openapi-types still types this as OctokitResponse<never, 204> because\n              // it hasn't picked up the updated GitHub OpenAPI spec yet.\n              // See: https://github.blog/changelog/2026-02-19-workflow-dispatch-api-now-returns-run-ids/\n              // This cast can be removed once @octokit/openapi-types includes the updated spec.\n              // Note: only supported on GitHub.com and GitHub Enterprise Cloud, not GitHub Enterprise Server\n              const data = response.data as unknown as {\n                workflow_run_id: number;\n                run_url: string;\n                html_url: string;\n              };\n\n              return {\n                workflowRunId: data.workflow_run_id,\n                workflowRunUrl: data.run_url,\n                workflowRunHtmlUrl: data.html_url,\n              };\n            }\n            return null;\n          },\n        });\n\n        if (runDetails) {\n          ctx.output('workflowRunId', runDetails.workflowRunId);\n          ctx.output('workflowRunUrl', runDetails.workflowRunUrl);\n          ctx.output('workflowRunHtmlUrl', runDetails.workflowRunHtmlUrl);\n\n          if (runDetails.workflowRunHtmlUrl) {\n            ctx.logger.info(\n              `Workflow run url: ${runDetails.workflowRunHtmlUrl}`,\n            );\n          }\n        }\n      } catch (e) {\n        const error = toError(e);\n        ctx.logger.warn(\n          `Failed: dispatching workflow '${workflowId}' on repo: '${repo}', ${error.message}`,\n        );\n        throw error;\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,kCAAkC,OAAA,EAI/C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EACE,+DAAA;AAAA,cACFC,uCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,eAAA,EAAiB,CAAA,CAAA,KACf,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,gBAAgB,CAAA,CAAA,KACd,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,wBAAA,EAA0B,CAAA,CAAA,KACxB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,aAAA,EAAe,OACb,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,+BAAA,EAAiC,CAAA,CAAE,QAAA,EAAS;AAAA,QACtE,cAAA,EAAgB,OACd,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,6BAAA,EAA+B,CAAA,CAAE,QAAA,EAAS;AAAA,QACpE,kBAAA,EAAoB,OAClB,CAAA,CAAE,MAAA,CAAO,EAAE,WAAA,EAAa,8BAAA,EAAgC,CAAA,CAAE,QAAA;AAAS;AACvE,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,eAAA;AAAA,QACA,cAAA;AAAA,QACA,wBAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACT,CAAA,qBAAA,EAAwB,UAAU,CAAA,UAAA,EAAa,OAAO,OAAO,eAAe,CAAA;AAAA,OAC9E;AAEA,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,KAAA,EAAO;AAAA,OACR,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI;AACF,QAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACtC,KAAK,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UAC5D,IAAI,YAAY;AACd,YAAA,MAAM,cAAA,GAAiB;AAAA,cACrB,KAAA;AAAA,cACA,IAAA;AAAA,cACA,WAAA,EAAa,UAAA;AAAA,cACb,GAAA,EAAK,eAAA;AAAA,cACL,MAAA,EAAQ,cAAA;AAAA,cACR,GAAI,wBAAA,GAA2B,EAAE,kBAAA,EAAoB,IAAA,KAAS;AAAC,aACjE;AACA,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,sBAAA;AAAA,cACzC;AAAA,aACF;AAEA,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,UAAU,CAAA,wBAAA,CAA0B,CAAA;AAEhE,YAAA,IAAI,wBAAA,IAA4B,SAAS,IAAA,EAAM;AAO7C,cAAA,MAAM,OAAO,QAAA,CAAS,IAAA;AAMtB,cAAA,OAAO;AAAA,gBACL,eAAe,IAAA,CAAK,eAAA;AAAA,gBACpB,gBAAgB,IAAA,CAAK,OAAA;AAAA,gBACrB,oBAAoB,IAAA,CAAK;AAAA,eAC3B;AAAA,YACF;AACA,YAAA,OAAO,IAAA;AAAA,UACT;AAAA,SACD,CAAA;AAED,QAAA,IAAI,UAAA,EAAY;AACd,UAAA,GAAA,CAAI,MAAA,CAAO,eAAA,EAAiB,UAAA,CAAW,aAAa,CAAA;AACpD,UAAA,GAAA,CAAI,MAAA,CAAO,gBAAA,EAAkB,UAAA,CAAW,cAAc,CAAA;AACtD,UAAA,GAAA,CAAI,MAAA,CAAO,oBAAA,EAAsB,UAAA,CAAW,kBAAkB,CAAA;AAE9D,UAAA,IAAI,WAAW,kBAAA,EAAoB;AACjC,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,cACT,CAAA,kBAAA,EAAqB,WAAW,kBAAkB,CAAA;AAAA,aACpD;AAAA,UACF;AAAA,QACF;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,iCAAiC,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,MAAM,OAAO,CAAA;AAAA,SACnF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubAutolinks.cjs.js

@@ -7,7 +7,7 @@ var githubAutolinks_examples = require('./githubAutolinks.examples.cjs.js');
 var util = require('../util.cjs.js');
 
 function createGithubAutolinksAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:autolinks:create",
     description: "Create an autolink reference for a repository",
@@ -40,6 +40,7 @@ function createGithubAutolinksAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         host,
         owner,
         repo,

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

@@ -1 +1 @@
-{"version":3,"file":"githubAutolinks.cjs.js","sources":["../../src/actions/githubAutolinks.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  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { examples } from './githubAutolinks.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Create an autolink reference for a repository\n * @public\n */\nexport function createGithubAutolinksAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:autolinks:create',\n    description: 'Create an autolink reference for a repository',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        keyPrefix: z =>\n          z.string({\n            description:\n              'This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.',\n          }),\n        urlTemplate: z =>\n          z.string({\n            description:\n              'The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of isAlphanumeric.',\n          }),\n        isAlphanumeric: z =>\n          z\n            .boolean({\n              description:\n                'Whether this autolink reference matches alphanumeric characters. If `true`, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If `false`, this autolink reference only matches numeric characters. Default: `true`',\n            })\n            .default(true)\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const { repoUrl, keyPrefix, urlTemplate, isAlphanumeric, token } =\n        ctx.input;\n\n      ctx.logger.info(`Creating autolink reference for repo ${repoUrl}`);\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        host,\n        owner,\n        repo,\n        credentialsProvider: githubCredentialsProvider,\n        token,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      await ctx.checkpoint({\n        key: `create.auto.link.${owner}.${repo}`,\n        fn: async () => {\n          await client.rest.repos.createAutolink({\n            owner,\n            repo,\n            key_prefix: keyPrefix,\n            url_template: urlTemplate,\n            is_alphanumeric: isAlphanumeric,\n          });\n\n          ctx.logger.info(`Autolink reference created successfully`);\n        },\n      });\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAiCO,SAAS,4BAA4B,OAAA,EAGzC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EAAa,+CAAA;AAAA,cACbC,iCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,cAAA,EAAgB,CAAA,CAAA,KACd,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,IAAI,EACZ,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,OAAA,EAAS,SAAA,EAAW,aAAa,cAAA,EAAgB,KAAA,KACvD,GAAA,CAAI,KAAA;AAEN,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,qCAAA,EAAwC,OAAO,CAAA,CAAE,CAAA;AAEjE,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,iBAAA,EAAoB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACtC,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,cAAA,CAAe;AAAA,YACrC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,UAAA,EAAY,SAAA;AAAA,YACZ,YAAA,EAAc,WAAA;AAAA,YACd,eAAA,EAAiB;AAAA,WAClB,CAAA;AAED,UAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,uCAAA,CAAyC,CAAA;AAAA,QAC3D;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubAutolinks.cjs.js","sources":["../../src/actions/githubAutolinks.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  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { examples } from './githubAutolinks.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Create an autolink reference for a repository\n * @public\n */\nexport function createGithubAutolinksAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:autolinks:create',\n    description: 'Create an autolink reference for a repository',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        keyPrefix: z =>\n          z.string({\n            description:\n              'This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.',\n          }),\n        urlTemplate: z =>\n          z.string({\n            description:\n              'The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of isAlphanumeric.',\n          }),\n        isAlphanumeric: z =>\n          z\n            .boolean({\n              description:\n                'Whether this autolink reference matches alphanumeric characters. If `true`, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If `false`, this autolink reference only matches numeric characters. Default: `true`',\n            })\n            .default(true)\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const { repoUrl, keyPrefix, urlTemplate, isAlphanumeric, token } =\n        ctx.input;\n\n      ctx.logger.info(`Creating autolink reference for repo ${repoUrl}`);\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        requireScmUserCredentials,\n        host,\n        owner,\n        repo,\n        credentialsProvider: githubCredentialsProvider,\n        token,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      await ctx.checkpoint({\n        key: `create.auto.link.${owner}.${repo}`,\n        fn: async () => {\n          await client.rest.repos.createAutolink({\n            owner,\n            repo,\n            key_prefix: keyPrefix,\n            url_template: urlTemplate,\n            is_alphanumeric: isAlphanumeric,\n          });\n\n          ctx.logger.info(`Autolink reference created successfully`);\n        },\n      });\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAiCO,SAAS,4BAA4B,OAAA,EAIzC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EAAa,+CAAA;AAAA,cACbC,iCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,cAAA,EAAgB,CAAA,CAAA,KACd,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,IAAI,EACZ,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,OAAA,EAAS,SAAA,EAAW,aAAa,cAAA,EAAgB,KAAA,KACvD,GAAA,CAAI,KAAA;AAEN,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,qCAAA,EAAwC,OAAO,CAAA,CAAE,CAAA;AAEjE,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,iBAAA,EAAoB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACtC,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,cAAA,CAAe;AAAA,YACrC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,UAAA,EAAY,SAAA;AAAA,YACZ,YAAA,EAAc,WAAA;AAAA,YACd,eAAA,EAAiB;AAAA,WAClB,CAAA;AAED,UAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,uCAAA,CAAyC,CAAA;AAAA,QAC3D;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubBranchProtection.cjs.js

@@ -9,7 +9,7 @@ var octokit = require('octokit');
 var gitHelpers = require('./gitHelpers.cjs.js');
 
 function createGithubBranchProtectionAction(options) {
-  const { integrations } = options;
+  const { integrations, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:branch-protection:create",
     description: "Configures Branch Protection",
@@ -59,6 +59,7 @@ function createGithubBranchProtectionAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         token: providedToken,
         host,
         owner,

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

@@ -1 +1 @@
-{"version":3,"file":"githubBranchProtection.cjs.js","sources":["../../src/actions/githubBranchProtection.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  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { examples } from './githubBranchProtection.examples';\nimport * as inputProps from './inputProperties';\nimport { getOctokitOptions } from '../util';\nimport { Octokit } from 'octokit';\nimport { enableBranchProtectionOnDefaultRepoBranch } from './gitHelpers';\n\n/**\n * Creates an `github:branch-protection:create` Scaffolder action that configured Branch Protection in a Github Repository.\n *\n * @public\n */\nexport function createGithubBranchProtectionAction(options: {\n  integrations: ScmIntegrationRegistry;\n}) {\n  const { integrations } = options;\n\n  return createTemplateAction({\n    id: 'github:branch-protection:create',\n    description: 'Configures Branch Protection',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        branch: inputProps.branch,\n        enforceAdmins: inputProps.protectEnforceAdmins,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        restrictions: inputProps.restrictions,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        requiredCommitSigning: inputProps.requiredCommitSigning,\n        requiredLinearHistory: inputProps.requiredLinearHistory,\n        blockCreations: inputProps.blockCreations,\n        token: inputProps.token,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branch,\n        enforceAdmins = true,\n        requiredApprovingReviewCount = 1,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n        blockCreations,\n        token: providedToken,\n      } = ctx.input;\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      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      const defaultBranch = await ctx.checkpoint({\n        key: `read.default.branch.${owner}.${repo}`,\n        fn: async () => {\n          const repository = await client.rest.repos.get({\n            owner: owner,\n            repo: repo,\n          });\n          return repository.data.default_branch;\n        },\n      });\n\n      await ctx.checkpoint({\n        key: `enable.branch.protection.${owner}.${repo}`,\n        fn: async () => {\n          await enableBranchProtectionOnDefaultRepoBranch({\n            repoName: repo,\n            client,\n            owner,\n            logger: ctx.logger,\n            requireCodeOwnerReviews,\n            bypassPullRequestAllowances,\n            requiredApprovingReviewCount,\n            restrictions,\n            requiredStatusCheckContexts,\n            requireBranchesToBeUpToDate,\n            requiredConversationResolution,\n            requireLastPushApproval,\n            defaultBranch: branch ?? defaultBranch,\n            enforceAdmins,\n            dismissStaleReviews,\n            requiredCommitSigning,\n            requiredLinearHistory,\n            blockCreations,\n          });\n        },\n      });\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.branch","inputProps.protectEnforceAdmins","inputProps.requiredApprovingReviewCount","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.bypassPullRequestAllowances","inputProps.restrictions","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","inputProps.blockCreations","inputProps.token","parseRepoUrl","InputError","getOctokitOptions","Octokit","enableBranchProtectionOnDefaultRepoBranch"],"mappings":";;;;;;;;;;AAiCO,SAAS,mCAAmC,OAAA,EAEhD;AACD,EAAA,MAAM,EAAE,cAAa,GAAI,OAAA;AAEzB,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,iCAAA;AAAA,IACJ,WAAA,EAAa,8BAAA;AAAA,cACbC,wCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,QAAQC,sBAAW;AAAA,QACnB,eAAeC,oCAAW;AAAA,QAC1B,8BAA8BC,4CAAW;AAAA,QACzC,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,cAAcC,4BAAW;AAAA,QACzB,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC,qCAAW;AAAA,QAClC,gBAAgBC,8BAAW;AAAA,QAC3B,OAAOC;AAAW;AACpB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA,GAAgB,IAAA;AAAA,QAChB,4BAAA,GAA+B,CAAA;AAAA,QAC/B,uBAAA,GAA0B,KAAA;AAAA,QAC1B,mBAAA,GAAsB,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAAA,GAA8B,IAAA;AAAA,QAC9B,8BAAA,GAAiC,KAAA;AAAA,QACjC,uBAAA,GAA0B,KAAA;AAAA,QAC1B,qBAAA,GAAwB,KAAA;AAAA,QACxB,qBAAA,GAAwB,KAAA;AAAA,QACxB,cAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,aAAA,GAAgB,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACzC,GAAA,EAAK,CAAA,oBAAA,EAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACzC,IAAI,YAAY;AACd,UAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI;AAAA,YAC7C,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO,WAAW,IAAA,CAAK,cAAA;AAAA,QACzB;AAAA,OACD,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC9C,IAAI,YAAY;AACd,UAAA,MAAMC,oDAAA,CAA0C;AAAA,YAC9C,QAAA,EAAU,IAAA;AAAA,YACV,MAAA;AAAA,YACA,KAAA;AAAA,YACA,QAAQ,GAAA,CAAI,MAAA;AAAA,YACZ,uBAAA;AAAA,YACA,2BAAA;AAAA,YACA,4BAAA;AAAA,YACA,YAAA;AAAA,YACA,2BAAA;AAAA,YACA,2BAAA;AAAA,YACA,8BAAA;AAAA,YACA,uBAAA;AAAA,YACA,eAAe,MAAA,IAAU,aAAA;AAAA,YACzB,aAAA;AAAA,YACA,mBAAA;AAAA,YACA,qBAAA;AAAA,YACA,qBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubBranchProtection.cjs.js","sources":["../../src/actions/githubBranchProtection.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  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { examples } from './githubBranchProtection.examples';\nimport * as inputProps from './inputProperties';\nimport { getOctokitOptions } from '../util';\nimport { Octokit } from 'octokit';\nimport { enableBranchProtectionOnDefaultRepoBranch } from './gitHelpers';\n\n/**\n * Creates an `github:branch-protection:create` Scaffolder action that configured Branch Protection in a Github Repository.\n *\n * @public\n */\nexport function createGithubBranchProtectionAction(options: {\n  integrations: ScmIntegrationRegistry;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, requireScmUserCredentials } = options;\n\n  return createTemplateAction({\n    id: 'github:branch-protection:create',\n    description: 'Configures Branch Protection',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        branch: inputProps.branch,\n        enforceAdmins: inputProps.protectEnforceAdmins,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        restrictions: inputProps.restrictions,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        requiredCommitSigning: inputProps.requiredCommitSigning,\n        requiredLinearHistory: inputProps.requiredLinearHistory,\n        blockCreations: inputProps.blockCreations,\n        token: inputProps.token,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branch,\n        enforceAdmins = true,\n        requiredApprovingReviewCount = 1,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n        blockCreations,\n        token: providedToken,\n      } = ctx.input;\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        requireScmUserCredentials,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      const defaultBranch = await ctx.checkpoint({\n        key: `read.default.branch.${owner}.${repo}`,\n        fn: async () => {\n          const repository = await client.rest.repos.get({\n            owner: owner,\n            repo: repo,\n          });\n          return repository.data.default_branch;\n        },\n      });\n\n      await ctx.checkpoint({\n        key: `enable.branch.protection.${owner}.${repo}`,\n        fn: async () => {\n          await enableBranchProtectionOnDefaultRepoBranch({\n            repoName: repo,\n            client,\n            owner,\n            logger: ctx.logger,\n            requireCodeOwnerReviews,\n            bypassPullRequestAllowances,\n            requiredApprovingReviewCount,\n            restrictions,\n            requiredStatusCheckContexts,\n            requireBranchesToBeUpToDate,\n            requiredConversationResolution,\n            requireLastPushApproval,\n            defaultBranch: branch ?? defaultBranch,\n            enforceAdmins,\n            dismissStaleReviews,\n            requiredCommitSigning,\n            requiredLinearHistory,\n            blockCreations,\n          });\n        },\n      });\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.branch","inputProps.protectEnforceAdmins","inputProps.requiredApprovingReviewCount","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.bypassPullRequestAllowances","inputProps.restrictions","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","inputProps.blockCreations","inputProps.token","parseRepoUrl","InputError","getOctokitOptions","Octokit","enableBranchProtectionOnDefaultRepoBranch"],"mappings":";;;;;;;;;;AAiCO,SAAS,mCAAmC,OAAA,EAGhD;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,iCAAA;AAAA,IACJ,WAAA,EAAa,8BAAA;AAAA,cACbC,wCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,QAAQC,sBAAW;AAAA,QACnB,eAAeC,oCAAW;AAAA,QAC1B,8BAA8BC,4CAAW;AAAA,QACzC,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,cAAcC,4BAAW;AAAA,QACzB,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC,qCAAW;AAAA,QAClC,gBAAgBC,8BAAW;AAAA,QAC3B,OAAOC;AAAW;AACpB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA,GAAgB,IAAA;AAAA,QAChB,4BAAA,GAA+B,CAAA;AAAA,QAC/B,uBAAA,GAA0B,KAAA;AAAA,QAC1B,mBAAA,GAAsB,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAAA,GAA8B,IAAA;AAAA,QAC9B,8BAAA,GAAiC,KAAA;AAAA,QACjC,uBAAA,GAA0B,KAAA;AAAA,QAC1B,qBAAA,GAAwB,KAAA;AAAA,QACxB,qBAAA,GAAwB,KAAA;AAAA,QACxB,cAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,aAAA,GAAgB,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACzC,GAAA,EAAK,CAAA,oBAAA,EAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACzC,IAAI,YAAY;AACd,UAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI;AAAA,YAC7C,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO,WAAW,IAAA,CAAK,cAAA;AAAA,QACzB;AAAA,OACD,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC9C,IAAI,YAAY;AACd,UAAA,MAAMC,oDAAA,CAA0C;AAAA,YAC9C,QAAA,EAAU,IAAA;AAAA,YACV,MAAA;AAAA,YACA,KAAA;AAAA,YACA,QAAQ,GAAA,CAAI,MAAA;AAAA,YACZ,uBAAA;AAAA,YACA,2BAAA;AAAA,YACA,4BAAA;AAAA,YACA,YAAA;AAAA,YACA,2BAAA;AAAA,YACA,2BAAA;AAAA,YACA,8BAAA;AAAA,YACA,uBAAA;AAAA,YACA,eAAe,MAAA,IAAU,aAAA;AAAA,YACzB,aAAA;AAAA,YACA,mBAAA;AAAA,YACA,qBAAA;AAAA,YACA,qBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubDeployKey.cjs.js

@@ -12,7 +12,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var Sodium__default = /*#__PURE__*/_interopDefaultCompat(Sodium);
 
 function createGithubDeployKeyAction(options) {
-  const { integrations } = options;
+  const { integrations, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:deployKey:create",
     description: "Creates and stores Deploy Keys",
@@ -59,6 +59,7 @@ function createGithubDeployKeyAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         token: providedToken,
         host,
         owner,

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

@@ -1 +1 @@
-{"version":3,"file":"githubDeployKey.cjs.js","sources":["../../src/actions/githubDeployKey.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 './githubDeployKey.examples';\n\n/**\n * Creates an `github:deployKey:create` Scaffolder action that creates a Deploy Key\n *\n * @public\n */\nexport function createGithubDeployKeyAction(options: {\n  integrations: ScmIntegrationRegistry;\n}) {\n  const { integrations } = 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    id: 'github:deployKey:create',\n    description: 'Creates and stores Deploy Keys',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        publicKey: z =>\n          z.string({\n            description:\n              'Generated from `ssh-keygen`.  Begins with `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`, `ssh-ed25519`, `sk-ecdsa-sha2-nistp256@openssh.com`, or `sk-ssh-ed25519@openssh.com`.',\n          }),\n        privateKey: z =>\n          z.string({\n            description: 'SSH Private Key generated from `ssh-keygen`',\n          }),\n        deployKeyName: z =>\n          z.string({\n            description: `Name of the Deploy Key`,\n          }),\n        privateKeySecretName: z =>\n          z\n            .string({\n              description:\n                'Name of the GitHub Secret to store the private key related to the Deploy Key.  Defaults to: `KEY_NAME_PRIVATE_KEY` where `KEY_NAME` is the name of the Deploy Key',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        privateKeySecretName: z =>\n          z.string({\n            description:\n              'The GitHub Action Repo Secret Name for the Private Key',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        publicKey,\n        privateKey,\n        deployKeyName,\n        privateKeySecretName = `${deployKeyName\n          .split(' ')\n          .join('_')\n          .toLocaleUpperCase('en-US')}_PRIVATE_KEY`,\n        token: providedToken,\n      } = ctx.input;\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({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      await ctx.checkpoint({\n        key: `create.deploy.key.${owner}.${repo}.${publicKey}`,\n        fn: async () => {\n          await client.rest.repos.createDeployKey({\n            owner: owner,\n            repo: repo,\n            title: deployKeyName,\n            key: publicKey,\n          });\n        },\n      });\n\n      const { key, keyId } = await ctx.checkpoint({\n        key: `get.repo.public.key.${owner}.${repo}`,\n        fn: async () => {\n          const publicKeyResponse = await client.rest.actions.getRepoPublicKey({\n            owner: owner,\n            repo: repo,\n          });\n          return {\n            key: publicKeyResponse.data.key,\n            keyId: publicKeyResponse.data.key_id,\n          };\n        },\n      });\n\n      await Sodium.ready;\n      const binaryKey = Sodium.from_base64(\n        key,\n        Sodium.base64_variants.ORIGINAL,\n      );\n      const binarySecret = Sodium.from_string(privateKey);\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.repo.secret.${owner}.${repo}.${keyId}`,\n        fn: async () => {\n          await client.rest.actions.createOrUpdateRepoSecret({\n            owner: owner,\n            repo: repo,\n            secret_name: privateKeySecretName,\n            encrypted_value: encryptedBase64Secret,\n            key_id: keyId,\n          });\n        },\n      });\n\n      ctx.output('privateKeySecretName', privateKeySecretName);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","Sodium"],"mappings":";;;;;;;;;;;;;AAgCO,SAAS,4BAA4B,OAAA,EAEzC;AACD,EAAA,MAAM,EAAE,cAAa,GAAI,OAAA;AAGzB,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EAAa,gCAAA;AAAA,cACbC,iCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,sBAAA;AAAA,SACd,CAAA;AAAA,QACH,oBAAA,EAAsB,CAAA,CAAA,KACpB,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,oBAAA,EAAsB,CAAA,CAAA,KACpB,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH;AAAA;AACL,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAA;AAAA,QACA,oBAAA,GAAuB,CAAA,EAAG,aAAA,CACvB,KAAA,CAAM,GAAG,CAAA,CACT,IAAA,CAAK,GAAG,CAAA,CACR,iBAAA,CAAkB,OAAO,CAAC,CAAA,YAAA,CAAA;AAAA,QAC7B,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,kBAAA,EAAqB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,SAAS,CAAA,CAAA;AAAA,QACpD,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,YACtC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA,EAAO,aAAA;AAAA,YACP,GAAA,EAAK;AAAA,WACN,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,QAC1C,GAAA,EAAK,CAAA,oBAAA,EAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACzC,IAAI,YAAY;AACd,UAAA,MAAM,iBAAA,GAAoB,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,gBAAA,CAAiB;AAAA,YACnE,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO;AAAA,YACL,GAAA,EAAK,kBAAkB,IAAA,CAAK,GAAA;AAAA,YAC5B,KAAA,EAAO,kBAAkB,IAAA,CAAK;AAAA,WAChC;AAAA,QACF;AAAA,OACD,CAAA;AAED,MAAA,MAAMC,uBAAA,CAAO,KAAA;AACb,MAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,QACvB,GAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AACA,MAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,UAAU,CAAA;AAClD,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,QACnC,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,QACnC,qBAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,KAAK,CAAA,CAAA;AAAA,QAC3D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,wBAAA,CAAyB;AAAA,YACjD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,WAAA,EAAa,oBAAA;AAAA,YACb,eAAA,EAAiB,qBAAA;AAAA,YACjB,MAAA,EAAQ;AAAA,WACT,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,wBAAwB,oBAAoB,CAAA;AAAA,IACzD;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubDeployKey.cjs.js","sources":["../../src/actions/githubDeployKey.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 './githubDeployKey.examples';\n\n/**\n * Creates an `github:deployKey:create` Scaffolder action that creates a Deploy Key\n *\n * @public\n */\nexport function createGithubDeployKeyAction(options: {\n  integrations: ScmIntegrationRegistry;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, requireScmUserCredentials } = 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    id: 'github:deployKey:create',\n    description: 'Creates and stores Deploy Keys',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        publicKey: z =>\n          z.string({\n            description:\n              'Generated from `ssh-keygen`.  Begins with `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, `ecdsa-sha2-nistp521`, `ssh-ed25519`, `sk-ecdsa-sha2-nistp256@openssh.com`, or `sk-ssh-ed25519@openssh.com`.',\n          }),\n        privateKey: z =>\n          z.string({\n            description: 'SSH Private Key generated from `ssh-keygen`',\n          }),\n        deployKeyName: z =>\n          z.string({\n            description: `Name of the Deploy Key`,\n          }),\n        privateKeySecretName: z =>\n          z\n            .string({\n              description:\n                'Name of the GitHub Secret to store the private key related to the Deploy Key.  Defaults to: `KEY_NAME_PRIVATE_KEY` where `KEY_NAME` is the name of the Deploy Key',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        privateKeySecretName: z =>\n          z.string({\n            description:\n              'The GitHub Action Repo Secret Name for the Private Key',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        publicKey,\n        privateKey,\n        deployKeyName,\n        privateKeySecretName = `${deployKeyName\n          .split(' ')\n          .join('_')\n          .toLocaleUpperCase('en-US')}_PRIVATE_KEY`,\n        token: providedToken,\n      } = ctx.input;\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        requireScmUserCredentials,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      await ctx.checkpoint({\n        key: `create.deploy.key.${owner}.${repo}.${publicKey}`,\n        fn: async () => {\n          await client.rest.repos.createDeployKey({\n            owner: owner,\n            repo: repo,\n            title: deployKeyName,\n            key: publicKey,\n          });\n        },\n      });\n\n      const { key, keyId } = await ctx.checkpoint({\n        key: `get.repo.public.key.${owner}.${repo}`,\n        fn: async () => {\n          const publicKeyResponse = await client.rest.actions.getRepoPublicKey({\n            owner: owner,\n            repo: repo,\n          });\n          return {\n            key: publicKeyResponse.data.key,\n            keyId: publicKeyResponse.data.key_id,\n          };\n        },\n      });\n\n      await Sodium.ready;\n      const binaryKey = Sodium.from_base64(\n        key,\n        Sodium.base64_variants.ORIGINAL,\n      );\n      const binarySecret = Sodium.from_string(privateKey);\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.repo.secret.${owner}.${repo}.${keyId}`,\n        fn: async () => {\n          await client.rest.actions.createOrUpdateRepoSecret({\n            owner: owner,\n            repo: repo,\n            secret_name: privateKeySecretName,\n            encrypted_value: encryptedBase64Secret,\n            key_id: keyId,\n          });\n        },\n      });\n\n      ctx.output('privateKeySecretName', privateKeySecretName);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","Sodium"],"mappings":";;;;;;;;;;;;;AAgCO,SAAS,4BAA4B,OAAA,EAGzC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAGpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,yBAAA;AAAA,IACJ,WAAA,EAAa,gCAAA;AAAA,cACbC,iCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,sBAAA;AAAA,SACd,CAAA;AAAA,QACH,oBAAA,EAAsB,CAAA,CAAA,KACpB,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,oBAAA,EAAsB,CAAA,CAAA,KACpB,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH;AAAA;AACL,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAA;AAAA,QACA,oBAAA,GAAuB,CAAA,EAAG,aAAA,CACvB,KAAA,CAAM,GAAG,CAAA,CACT,IAAA,CAAK,GAAG,CAAA,CACR,iBAAA,CAAkB,OAAO,CAAC,CAAA,YAAA,CAAA;AAAA,QAC7B,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,kBAAA,EAAqB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,SAAS,CAAA,CAAA;AAAA,QACpD,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,YACtC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA,EAAO,aAAA;AAAA,YACP,GAAA,EAAK;AAAA,WACN,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,QAC1C,GAAA,EAAK,CAAA,oBAAA,EAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QACzC,IAAI,YAAY;AACd,UAAA,MAAM,iBAAA,GAAoB,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,gBAAA,CAAiB;AAAA,YACnE,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO;AAAA,YACL,GAAA,EAAK,kBAAkB,IAAA,CAAK,GAAA;AAAA,YAC5B,KAAA,EAAO,kBAAkB,IAAA,CAAK;AAAA,WAChC;AAAA,QACF;AAAA,OACD,CAAA;AAED,MAAA,MAAMC,uBAAA,CAAO,KAAA;AACb,MAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,QACvB,GAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AACA,MAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,UAAU,CAAA;AAClD,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,QACnC,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,QACnC,qBAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,KAAK,CAAA,CAAA;AAAA,QAC3D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,wBAAA,CAAyB;AAAA,YACjD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,WAAA,EAAa,oBAAA;AAAA,YACb,eAAA,EAAiB,qBAAA;AAAA,YACjB,MAAA,EAAQ;AAAA,WACT,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,wBAAwB,oBAAoB,CAAA;AAAA,IACzD;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubEnvironment.cjs.js

@@ -12,7 +12,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var Sodium__default = /*#__PURE__*/_interopDefaultCompat(Sodium);
 
 function createGithubEnvironmentAction(options) {
-  const { integrations, catalog } = options;
+  const { integrations, catalog, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
@@ -89,6 +89,7 @@ Wildcard characters will not match \`/\`. For example, to match tags that begin
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         token: providedToken,
         host,
         owner,

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 { Entity } from '@backstage/catalog-model';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\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  catalog: CatalogService;\n}) {\n  const { integrations, catalog } = 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    id: 'github:environment:create',\n    description: 'Creates Deployment Environments',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        name: z =>\n          z.string({\n            description: `Name of the deployment environment to create`,\n          }),\n        deploymentBranchPolicy: z =>\n          z\n            .object(\n              {\n                protected_branches: z.boolean({\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                }),\n                custom_branch_policies: z.boolean({\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                }),\n              },\n              {\n                description:\n                  'The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.',\n              },\n            )\n            .optional(),\n        customBranchPolicyNames: z =>\n          z\n            .array(z.string(), {\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            })\n            .optional(),\n        customTagPolicyNames: z =>\n          z\n            .array(z.string(), {\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            })\n            .optional(),\n        environmentVariables: z =>\n          z\n            .record(z.string(), {\n              description: `Environment variables attached to the deployment environment`,\n            })\n            .optional(),\n        secrets: z =>\n          z\n            .record(z.string(), {\n              description: `Secrets attached to the deployment environment`,\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n        waitTimer: z =>\n          z\n            .number({\n              description:\n                'The time to wait before creating or updating the environment (in minutes)',\n            })\n            .optional(),\n        preventSelfReview: z =>\n          z\n            .boolean({\n              description:\n                'Whether to prevent self-review for this environment',\n            })\n            .optional(),\n        reviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Reviewers for this environment. Must be a list of Backstage entity references.',\n            })\n            .optional(),\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      // 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      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\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 catalog.getEntitiesByRefs(\n          {\n            entityRefs: reviewers,\n          },\n          {\n            credentials: await ctx.getInitiatorCredentials(),\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":";;;;;;;;;;;;;AAkCO,SAAS,8BAA8B,OAAA,EAG3C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,OAAA,EAAQ,GAAI,OAAA;AAGlC,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,2BAAA;AAAA,IACJ,WAAA,EAAa,iCAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,4CAAA;AAAA,SACd,CAAA;AAAA,QACH,sBAAA,EAAwB,OACtB,CAAA,CACG,MAAA;AAAA,UACC;AAAA,YACE,kBAAA,EAAoB,EAAE,OAAA,CAAQ;AAAA,cAC5B,WAAA,EACE;AAAA,aACH,CAAA;AAAA,YACD,sBAAA,EAAwB,EAAE,OAAA,CAAQ;AAAA,cAChC,WAAA,EACE;AAAA,aACH;AAAA,WACH;AAAA,UACA;AAAA,YACE,WAAA,EACE;AAAA;AACJ,UAED,QAAA,EAAS;AAAA,QACd,yBAAyB,CAAA,CAAA,KACvB,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa,CAAA;;AAAA,+PAAA;AAAA,SAGd,EACA,QAAA,EAAS;AAAA,QACd,sBAAsB,CAAA,CAAA,KACpB,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa,CAAA;;AAAA,2PAAA;AAAA,SAGd,EACA,QAAA,EAAS;AAAA,QACd,sBAAsB,CAAA,CAAA,KACpB,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa,CAAA,4DAAA;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAS,CAAA,CAAA,KACP,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa,CAAA,8CAAA;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,iBAAA,EAAmB,CAAA,CAAA,KACjB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,IAAA;AAAA,QACA,sBAAA;AAAA,QACA,uBAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,OAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,SAAA;AAAA,QACA,iBAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAIR,MAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAI,CAAC,CAAA;AAEtD,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,YAAA,GAAe,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACxC,GAAA,EAAK,CAAA,SAAA,EAAY,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC9B,IAAI,YAAY;AACd,UAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI;AAAA,YAC7C,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO,WAAW,IAAA,CAAK,EAAA;AAAA,QACzB;AAAA,OACD,CAAA;AAGD,MAAA,MAAM,kBAA2D,EAAC;AAClE,MAAA,IAAI,SAAA,EAAW;AACb,QAAA,IAAI,sBAAiD,EAAC;AAEtD,QAAA,MAAM,eAAA,GAAkB,MAAM,OAAA,CAAQ,iBAAA;AAAA,UACpC;AAAA,YACE,UAAA,EAAY;AAAA,WACd;AAAA,UACA;AAAA,YACE,WAAA,EAAa,MAAM,GAAA,CAAI,uBAAA;AAAwB;AACjD,SACF;AACA,QAAA,IAAI,eAAA,EAAiB,OAAO,MAAA,EAAQ;AAClC,UAAA,mBAAA,GAAsB,eAAA,CAAgB,KAAA;AAAA,QACxC;AAEA,QAAA,KAAA,MAAW,qBAAqB,mBAAA,EAAqB;AACnD,UAAA,IAAI,iBAAA,EAAmB,SAAS,MAAA,EAAQ;AACtC,YAAA,IAAI;AACF,cAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,gBAClC,GAAA,EAAK,CAAA,SAAA,EAAY,iBAAA,CAAkB,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,aAAA,CAAc;AAAA,oBACjD,QAAA,EAAU,kBAAkB,QAAA,CAAS;AAAA,mBACtC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAA,CAAK,EAAA;AAAA,gBACnB;AAAA,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,gBACnB,IAAA,EAAM,MAAA;AAAA,gBACN,EAAA,EAAI;AAAA,eACL,CAAA;AAAA,YACH,SAAS,KAAA,EAAO;AACd,cAAA,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,iBAAA,EAAmB,KAAK,CAAA;AAAA,YAC3C;AAAA,UACF,CAAA,MAAA,IAAW,iBAAA,EAAmB,IAAA,KAAS,OAAA,EAAS;AAC9C,YAAA,IAAI;AACF,cAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,gBAClC,GAAA,EAAK,CAAA,SAAA,EAAY,iBAAA,CAAkB,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,SAAA,CAAU;AAAA,oBAC7C,GAAA,EAAK,KAAA;AAAA,oBACL,SAAA,EAAW,kBAAkB,QAAA,CAAS;AAAA,mBACvC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAA,CAAK,EAAA;AAAA,gBACnB;AAAA,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,gBACnB,IAAA,EAAM,MAAA;AAAA,gBACN,EAAA,EAAI;AAAA,eACL,CAAA;AAAA,YACH,SAAS,KAAA,EAAO;AACd,cAAA,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,iBAAA,EAAmB,KAAK,CAAA;AAAA,YAC3C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,yBAAA,CAA0B;AAAA,YAChD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,gBAAA,EAAkB,IAAA;AAAA,YAClB,0BAA0B,sBAAA,IAA0B,MAAA;AAAA,YACpD,YAAY,SAAA,IAAa,MAAA;AAAA,YACzB,qBAAqB,iBAAA,IAAqB,MAAA;AAAA,YAC1C,SAAA,EAAW,eAAA,CAAgB,MAAA,GAAS,eAAA,GAAkB;AAAA,WACvD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,IAAI,uBAAA,EAAyB;AAC3B,QAAA,KAAA,MAAW,QAAQ,uBAAA,EAAyB;AAC1C,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,0CAA0C,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YAC5E,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,4BAAA,CAA6B;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAA,EAAM,QAAA;AAAA,gBACN,gBAAA,EAAkB,IAAA;AAAA,gBAClB,IAAA,EAAM;AAAA,eACP,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAEA,MAAA,IAAI,oBAAA,EAAsB;AACxB,QAAA,KAAA,MAAW,QAAQ,oBAAA,EAAsB;AACvC,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,uCAAuC,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YACzE,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,4BAAA,CAA6B;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAA,EAAM,KAAA;AAAA,gBACN,gBAAA,EAAkB,IAAA;AAAA,gBAClB,IAAA,EAAM;AAAA,eACP,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAEA,MAAA,KAAA,MAAW,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAA,CAAQ,oBAAA,IAAwB,EAAE,CAAA,EAAG;AACrE,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,GAAA,EAAK,uBAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,UACxD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,yBAAA,CAA0B;AAAA,cAClD,aAAA,EAAe,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAA,EAAkB,IAAA;AAAA,cAClB,IAAA,EAAM,GAAA;AAAA,cACN;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAAA,MACH;AAEA,MAAA,IAAI,OAAA,EAAS;AACX,QAAA,MAAM,EAAE,SAAA,EAAW,WAAA,EAAY,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,UACtD,KAAK,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,UAChD,IAAI,YAAY;AACd,YAAA,MAAM,iBAAA,GACJ,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,uBAAA,CAAwB;AAAA,cAChD,aAAA,EAAe,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAA,EAAkB;AAAA,aACnB,CAAA;AACH,YAAA,OAAO;AAAA,cACL,SAAA,EAAW,kBAAkB,IAAA,CAAK,GAAA;AAAA,cAClC,WAAA,EAAa,kBAAkB,IAAA,CAAK;AAAA,aACtC;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,MAAMC,uBAAA,CAAO,KAAA;AACb,QAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,UACvB,SAAA;AAAA,UACAA,wBAAO,eAAA,CAAgB;AAAA,SACzB;AACA,QAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAO,CAAA,EAAG;AAClD,UAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,KAAK,CAAA;AAC7C,UAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,YACnC,qBAAA;AAAA,YACAA,wBAAO,eAAA,CAAgB;AAAA,WACzB;AAEA,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,+BAA+B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,YAChE,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,+BAAA,CAAgC;AAAA,gBACxD,aAAA,EAAe,YAAA;AAAA,gBACf,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,gBAAA,EAAkB,IAAA;AAAA,gBAClB,WAAA,EAAa,GAAA;AAAA,gBACb,eAAA,EAAiB,qBAAA;AAAA,gBACjB,MAAA,EAAQ;AAAA,eACT,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,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 { Entity } from '@backstage/catalog-model';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\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  catalog: CatalogService;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, catalog, requireScmUserCredentials } = 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    id: 'github:environment:create',\n    description: 'Creates Deployment Environments',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        name: z =>\n          z.string({\n            description: `Name of the deployment environment to create`,\n          }),\n        deploymentBranchPolicy: z =>\n          z\n            .object(\n              {\n                protected_branches: z.boolean({\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                }),\n                custom_branch_policies: z.boolean({\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                }),\n              },\n              {\n                description:\n                  'The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.',\n              },\n            )\n            .optional(),\n        customBranchPolicyNames: z =>\n          z\n            .array(z.string(), {\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            })\n            .optional(),\n        customTagPolicyNames: z =>\n          z\n            .array(z.string(), {\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            })\n            .optional(),\n        environmentVariables: z =>\n          z\n            .record(z.string(), {\n              description: `Environment variables attached to the deployment environment`,\n            })\n            .optional(),\n        secrets: z =>\n          z\n            .record(z.string(), {\n              description: `Secrets attached to the deployment environment`,\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n        waitTimer: z =>\n          z\n            .number({\n              description:\n                'The time to wait before creating or updating the environment (in minutes)',\n            })\n            .optional(),\n        preventSelfReview: z =>\n          z\n            .boolean({\n              description:\n                'Whether to prevent self-review for this environment',\n            })\n            .optional(),\n        reviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Reviewers for this environment. Must be a list of Backstage entity references.',\n            })\n            .optional(),\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      // 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        requireScmUserCredentials,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\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 catalog.getEntitiesByRefs(\n          {\n            entityRefs: reviewers,\n          },\n          {\n            credentials: await ctx.getInitiatorCredentials(),\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":";;;;;;;;;;;;;AAkCO,SAAS,8BAA8B,OAAA,EAI3C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,OAAA,EAAS,yBAAA,EAA0B,GAAI,OAAA;AAG7D,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,2BAAA;AAAA,IACJ,WAAA,EAAa,iCAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,4CAAA;AAAA,SACd,CAAA;AAAA,QACH,sBAAA,EAAwB,OACtB,CAAA,CACG,MAAA;AAAA,UACC;AAAA,YACE,kBAAA,EAAoB,EAAE,OAAA,CAAQ;AAAA,cAC5B,WAAA,EACE;AAAA,aACH,CAAA;AAAA,YACD,sBAAA,EAAwB,EAAE,OAAA,CAAQ;AAAA,cAChC,WAAA,EACE;AAAA,aACH;AAAA,WACH;AAAA,UACA;AAAA,YACE,WAAA,EACE;AAAA;AACJ,UAED,QAAA,EAAS;AAAA,QACd,yBAAyB,CAAA,CAAA,KACvB,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa,CAAA;;AAAA,+PAAA;AAAA,SAGd,EACA,QAAA,EAAS;AAAA,QACd,sBAAsB,CAAA,CAAA,KACpB,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa,CAAA;;AAAA,2PAAA;AAAA,SAGd,EACA,QAAA,EAAS;AAAA,QACd,sBAAsB,CAAA,CAAA,KACpB,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa,CAAA,4DAAA;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAS,CAAA,CAAA,KACP,CAAA,CACG,MAAA,CAAO,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa,CAAA,8CAAA;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,iBAAA,EAAmB,CAAA,CAAA,KACjB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,IAAA;AAAA,QACA,sBAAA;AAAA,QACA,uBAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,OAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,SAAA;AAAA,QACA,iBAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAIR,MAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,GAAI,CAAC,CAAA;AAEtD,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,IAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,YAAA,GAAe,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACxC,GAAA,EAAK,CAAA,SAAA,EAAY,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC9B,IAAI,YAAY;AACd,UAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI;AAAA,YAC7C,KAAA;AAAA,YACA;AAAA,WACD,CAAA;AACD,UAAA,OAAO,WAAW,IAAA,CAAK,EAAA;AAAA,QACzB;AAAA,OACD,CAAA;AAGD,MAAA,MAAM,kBAA2D,EAAC;AAClE,MAAA,IAAI,SAAA,EAAW;AACb,QAAA,IAAI,sBAAiD,EAAC;AAEtD,QAAA,MAAM,eAAA,GAAkB,MAAM,OAAA,CAAQ,iBAAA;AAAA,UACpC;AAAA,YACE,UAAA,EAAY;AAAA,WACd;AAAA,UACA;AAAA,YACE,WAAA,EAAa,MAAM,GAAA,CAAI,uBAAA;AAAwB;AACjD,SACF;AACA,QAAA,IAAI,eAAA,EAAiB,OAAO,MAAA,EAAQ;AAClC,UAAA,mBAAA,GAAsB,eAAA,CAAgB,KAAA;AAAA,QACxC;AAEA,QAAA,KAAA,MAAW,qBAAqB,mBAAA,EAAqB;AACnD,UAAA,IAAI,iBAAA,EAAmB,SAAS,MAAA,EAAQ;AACtC,YAAA,IAAI;AACF,cAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,gBAClC,GAAA,EAAK,CAAA,SAAA,EAAY,iBAAA,CAAkB,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,aAAA,CAAc;AAAA,oBACjD,QAAA,EAAU,kBAAkB,QAAA,CAAS;AAAA,mBACtC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAA,CAAK,EAAA;AAAA,gBACnB;AAAA,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,gBACnB,IAAA,EAAM,MAAA;AAAA,gBACN,EAAA,EAAI;AAAA,eACL,CAAA;AAAA,YACH,SAAS,KAAA,EAAO;AACd,cAAA,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,iBAAA,EAAmB,KAAK,CAAA;AAAA,YAC3C;AAAA,UACF,CAAA,MAAA,IAAW,iBAAA,EAAmB,IAAA,KAAS,OAAA,EAAS;AAC9C,YAAA,IAAI;AACF,cAAA,MAAM,MAAA,GAAS,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,gBAClC,GAAA,EAAK,CAAA,SAAA,EAAY,iBAAA,CAAkB,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,gBAChD,IAAI,YAAY;AACd,kBAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,SAAA,CAAU;AAAA,oBAC7C,GAAA,EAAK,KAAA;AAAA,oBACL,SAAA,EAAW,kBAAkB,QAAA,CAAS;AAAA,mBACvC,CAAA;AACD,kBAAA,OAAO,KAAK,IAAA,CAAK,EAAA;AAAA,gBACnB;AAAA,eACD,CAAA;AAED,cAAA,eAAA,CAAgB,IAAA,CAAK;AAAA,gBACnB,IAAA,EAAM,MAAA;AAAA,gBACN,EAAA,EAAI;AAAA,eACL,CAAA;AAAA,YACH,SAAS,KAAA,EAAO;AACd,cAAA,GAAA,CAAI,MAAA,CAAO,KAAA,CAAM,iBAAA,EAAmB,KAAK,CAAA;AAAA,YAC3C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,KAAK,CAAA,6BAAA,EAAgC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,yBAAA,CAA0B;AAAA,YAChD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,gBAAA,EAAkB,IAAA;AAAA,YAClB,0BAA0B,sBAAA,IAA0B,MAAA;AAAA,YACpD,YAAY,SAAA,IAAa,MAAA;AAAA,YACzB,qBAAqB,iBAAA,IAAqB,MAAA;AAAA,YAC1C,SAAA,EAAW,eAAA,CAAgB,MAAA,GAAS,eAAA,GAAkB;AAAA,WACvD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,IAAI,uBAAA,EAAyB;AAC3B,QAAA,KAAA,MAAW,QAAQ,uBAAA,EAAyB;AAC1C,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,0CAA0C,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YAC5E,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,4BAAA,CAA6B;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAA,EAAM,QAAA;AAAA,gBACN,gBAAA,EAAkB,IAAA;AAAA,gBAClB,IAAA,EAAM;AAAA,eACP,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAEA,MAAA,IAAI,oBAAA,EAAsB;AACxB,QAAA,KAAA,MAAW,QAAQ,oBAAA,EAAsB;AACvC,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,uCAAuC,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,YACzE,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,4BAAA,CAA6B;AAAA,gBACnD,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,IAAA,EAAM,KAAA;AAAA,gBACN,gBAAA,EAAkB,IAAA;AAAA,gBAClB,IAAA,EAAM;AAAA,eACP,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAEA,MAAA,KAAA,MAAW,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAA,CAAQ,oBAAA,IAAwB,EAAE,CAAA,EAAG;AACrE,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,GAAA,EAAK,uBAAuB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,UACxD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,yBAAA,CAA0B;AAAA,cAClD,aAAA,EAAe,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAA,EAAkB,IAAA;AAAA,cAClB,IAAA,EAAM,GAAA;AAAA,cACN;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAAA,MACH;AAEA,MAAA,IAAI,OAAA,EAAS;AACX,QAAA,MAAM,EAAE,SAAA,EAAW,WAAA,EAAY,GAAI,MAAM,IAAI,UAAA,CAAW;AAAA,UACtD,KAAK,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,UAChD,IAAI,YAAY;AACd,YAAA,MAAM,iBAAA,GACJ,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,uBAAA,CAAwB;AAAA,cAChD,aAAA,EAAe,YAAA;AAAA,cACf,KAAA;AAAA,cACA,IAAA;AAAA,cACA,gBAAA,EAAkB;AAAA,aACnB,CAAA;AACH,YAAA,OAAO;AAAA,cACL,SAAA,EAAW,kBAAkB,IAAA,CAAK,GAAA;AAAA,cAClC,WAAA,EAAa,kBAAkB,IAAA,CAAK;AAAA,aACtC;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,MAAMC,uBAAA,CAAO,KAAA;AACb,QAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,UACvB,SAAA;AAAA,UACAA,wBAAO,eAAA,CAAgB;AAAA,SACzB;AACA,QAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAO,CAAA,EAAG;AAClD,UAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,KAAK,CAAA;AAC7C,UAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,YACnC,qBAAA;AAAA,YACAA,wBAAO,eAAA,CAAgB;AAAA,WACzB;AAEA,UAAA,MAAM,IAAI,UAAA,CAAW;AAAA,YACnB,GAAA,EAAK,+BAA+B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,IAAI,GAAG,CAAA,CAAA;AAAA,YAChE,IAAI,YAAY;AACd,cAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,+BAAA,CAAgC;AAAA,gBACxD,aAAA,EAAe,YAAA;AAAA,gBACf,KAAA;AAAA,gBACA,IAAA;AAAA,gBACA,gBAAA,EAAkB,IAAA;AAAA,gBAClB,WAAA,EAAa,GAAA;AAAA,gBACb,eAAA,EAAiB,qBAAA;AAAA,gBACjB,MAAA,EAAQ;AAAA,eACT,CAAA;AAAA,YACH;AAAA,WACD,CAAA;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubIssuesCreate.cjs.js

@@ -7,7 +7,7 @@ var util = require('../util.cjs.js');
 var githubIssuesCreate_examples = require('./githubIssuesCreate.examples.cjs.js');
 
 function createGithubIssuesCreateAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:create",
     description: "Creates an issue on GitHub.",
@@ -63,6 +63,7 @@ function createGithubIssuesCreateAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         host,
         owner,

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

@@ -1 +1 @@
-{"version":3,"file":"githubIssuesCreate.cjs.js","sources":["../../src/actions/githubIssuesCreate.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 { InputError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubIssuesCreate.examples';\n\n/**\n * Creates an issue on GitHub\n * @public\n */\nexport function createGithubIssuesCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:issues:create',\n    description: 'Creates an issue on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        title: z =>\n          z.string({\n            description: 'The title of the issue',\n          }),\n        body: z =>\n          z\n            .string({\n              description: 'The contents of the issue',\n            })\n            .optional(),\n        assignees: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.',\n            })\n            .optional(),\n        milestone: z =>\n          z\n            .union([z.string(), z.number()], {\n              description:\n                'The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.',\n            })\n            .optional(),\n        labels: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        issueUrl: z =>\n          z.string({\n            description: 'The URL of the created issue',\n          }),\n        issueNumber: z =>\n          z.number({\n            description: 'The number of the created issue',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        title,\n        body,\n        assignees,\n        milestone,\n        labels,\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n      ctx.logger.info(`Creating issue \"${title}\" on repo ${repo}`);\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        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating issue \"${title}\"`);\n        ctx.output('issueUrl', `https://github.com/${owner}/${repo}/issues/42`);\n        ctx.output('issueNumber', 42);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const issue = await ctx.checkpoint({\n          key: `github.issues.create.${owner}.${repo}.${title}`,\n          fn: async () => {\n            const response = await client.rest.issues.create({\n              owner,\n              repo,\n              title,\n              body,\n              assignees,\n              milestone,\n              labels,\n            });\n\n            return {\n              html_url: response.data.html_url,\n              number: response.data.number,\n            };\n          },\n        });\n\n        if (!issue) {\n          throw new Error('Failed to create issue');\n        }\n\n        ctx.output('issueUrl', issue.html_url);\n        ctx.output('issueNumber', issue.number);\n\n        ctx.logger.info(\n          `Successfully created issue #${issue.number}: ${issue.html_url}`,\n        );\n      } catch (e) {\n        const error = toError(e);\n        ctx.logger.warn(\n          `Failed: creating issue '${title}' on repo: '${repo}', ${error.message}`,\n        );\n        throw error;\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,+BAA+B,OAAA,EAG5C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,sBAAA;AAAA,IACJ,WAAA,EAAa,6BAAA;AAAA,cACbC,oCAAA;AAAA,IACA,cAAA,EAAgB,IAAA;AAAA,IAChB,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAC,CAAA,CAAE,MAAA,EAAO,EAAG,CAAA,CAAE,MAAA,EAAQ,CAAA,EAAG;AAAA,UAC/B,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,QAAQ,CAAA,CAAA,KACN,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,QAAA,EAAU,CAAA,CAAA,KACR,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd;AAAA;AACL,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,gBAAA,EAAmB,KAAK,CAAA,UAAA,EAAa,IAAI,CAAA,CAAE,CAAA;AAE3D,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,sCAAA,EAAyC,KAAK,CAAA,CAAA,CAAG,CAAA;AACjE,QAAA,GAAA,CAAI,OAAO,UAAA,EAAY,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,UAAA,CAAY,CAAA;AACtE,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,EAAE,CAAA;AAC5B,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,KAAA,GAAQ,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACjC,KAAK,CAAA,qBAAA,EAAwB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,KAAK,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,IAAA,CAAK,OAAO,MAAA,CAAO;AAAA,cAC/C,KAAA;AAAA,cACA,IAAA;AAAA,cACA,KAAA;AAAA,cACA,IAAA;AAAA,cACA,SAAA;AAAA,cACA,SAAA;AAAA,cACA;AAAA,aACD,CAAA;AAED,YAAA,OAAO;AAAA,cACL,QAAA,EAAU,SAAS,IAAA,CAAK,QAAA;AAAA,cACxB,MAAA,EAAQ,SAAS,IAAA,CAAK;AAAA,aACxB;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,IAAI,CAAC,KAAA,EAAO;AACV,UAAA,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAAA,QAC1C;AAEA,QAAA,GAAA,CAAI,MAAA,CAAO,UAAA,EAAY,KAAA,CAAM,QAAQ,CAAA;AACrC,QAAA,GAAA,CAAI,MAAA,CAAO,aAAA,EAAe,KAAA,CAAM,MAAM,CAAA;AAEtC,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,4BAAA,EAA+B,KAAA,CAAM,MAAM,CAAA,EAAA,EAAK,MAAM,QAAQ,CAAA;AAAA,SAChE;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,2BAA2B,KAAK,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,MAAM,OAAO,CAAA;AAAA,SACxE;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubIssuesCreate.cjs.js","sources":["../../src/actions/githubIssuesCreate.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 { InputError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubIssuesCreate.examples';\n\n/**\n * Creates an issue on GitHub\n * @public\n */\nexport function createGithubIssuesCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:issues:create',\n    description: 'Creates an issue on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        title: z =>\n          z.string({\n            description: 'The title of the issue',\n          }),\n        body: z =>\n          z\n            .string({\n              description: 'The contents of the issue',\n            })\n            .optional(),\n        assignees: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.',\n            })\n            .optional(),\n        milestone: z =>\n          z\n            .union([z.string(), z.number()], {\n              description:\n                'The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.',\n            })\n            .optional(),\n        labels: z =>\n          z\n            .array(z.string(), {\n              description:\n                'Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n      output: {\n        issueUrl: z =>\n          z.string({\n            description: 'The URL of the created issue',\n          }),\n        issueNumber: z =>\n          z.number({\n            description: 'The number of the created issue',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        title,\n        body,\n        assignees,\n        milestone,\n        labels,\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n      ctx.logger.info(`Creating issue \"${title}\" on repo ${repo}`);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        requireScmUserCredentials,\n        credentialsProvider: githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating issue \"${title}\"`);\n        ctx.output('issueUrl', `https://github.com/${owner}/${repo}/issues/42`);\n        ctx.output('issueNumber', 42);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const issue = await ctx.checkpoint({\n          key: `github.issues.create.${owner}.${repo}.${title}`,\n          fn: async () => {\n            const response = await client.rest.issues.create({\n              owner,\n              repo,\n              title,\n              body,\n              assignees,\n              milestone,\n              labels,\n            });\n\n            return {\n              html_url: response.data.html_url,\n              number: response.data.number,\n            };\n          },\n        });\n\n        if (!issue) {\n          throw new Error('Failed to create issue');\n        }\n\n        ctx.output('issueUrl', issue.html_url);\n        ctx.output('issueNumber', issue.number);\n\n        ctx.logger.info(\n          `Successfully created issue #${issue.number}: ${issue.html_url}`,\n        );\n      } catch (e) {\n        const error = toError(e);\n        ctx.logger.warn(\n          `Failed: creating issue '${title}' on repo: '${repo}', ${error.message}`,\n        );\n        throw error;\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,+BAA+B,OAAA,EAI5C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,sBAAA;AAAA,IACJ,WAAA,EAAa,6BAAA;AAAA,cACbC,oCAAA;AAAA,IACA,cAAA,EAAgB,IAAA;AAAA,IAChB,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAC,CAAA,CAAE,MAAA,EAAO,EAAG,CAAA,CAAE,MAAA,EAAQ,CAAA,EAAG;AAAA,UAC/B,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,QAAQ,CAAA,CAAA,KACN,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,QAAA,EAAU,CAAA,CAAA,KACR,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd;AAAA;AACL,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,gBAAA,EAAmB,KAAK,CAAA,UAAA,EAAa,IAAI,CAAA,CAAE,CAAA;AAE3D,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,sCAAA,EAAyC,KAAK,CAAA,CAAA,CAAG,CAAA;AACjE,QAAA,GAAA,CAAI,OAAO,UAAA,EAAY,CAAA,mBAAA,EAAsB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,UAAA,CAAY,CAAA;AACtE,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,EAAE,CAAA;AAC5B,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,KAAA,GAAQ,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACjC,KAAK,CAAA,qBAAA,EAAwB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,KAAK,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,IAAA,CAAK,OAAO,MAAA,CAAO;AAAA,cAC/C,KAAA;AAAA,cACA,IAAA;AAAA,cACA,KAAA;AAAA,cACA,IAAA;AAAA,cACA,SAAA;AAAA,cACA,SAAA;AAAA,cACA;AAAA,aACD,CAAA;AAED,YAAA,OAAO;AAAA,cACL,QAAA,EAAU,SAAS,IAAA,CAAK,QAAA;AAAA,cACxB,MAAA,EAAQ,SAAS,IAAA,CAAK;AAAA,aACxB;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,IAAI,CAAC,KAAA,EAAO;AACV,UAAA,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAAA,QAC1C;AAEA,QAAA,GAAA,CAAI,MAAA,CAAO,UAAA,EAAY,KAAA,CAAM,QAAQ,CAAA;AACrC,QAAA,GAAA,CAAI,MAAA,CAAO,aAAA,EAAe,KAAA,CAAM,MAAM,CAAA;AAEtC,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,4BAAA,EAA+B,KAAA,CAAM,MAAM,CAAA,EAAA,EAAK,MAAM,QAAQ,CAAA;AAAA,SAChE;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,2BAA2B,KAAK,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,MAAM,OAAO,CAAA;AAAA,SACxE;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubIssuesLabel.cjs.js

@@ -7,7 +7,7 @@ var util = require('../util.cjs.js');
 var githubIssuesLabel_examples = require('./githubIssuesLabel.examples.cjs.js');
 
 function createGithubIssuesLabelAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
@@ -37,6 +37,7 @@ function createGithubIssuesLabelAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         host,
         owner,

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 { InputError, toError } 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    id: 'github:issues:label',\n    description: 'Adds labels to a pull request or issue on GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        number: z =>\n          z.number({\n            description: 'The pull request or issue number to add labels to',\n          }),\n        labels: z =>\n          z.array(z.string(), {\n            description: 'The labels to add to the pull request or issue',\n          }),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\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 octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\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        ctx.logger.warn(\n          `Failed: adding labels to issue: '${number}' on repo: '${repo}', ${\n            toError(e).message\n          }`,\n        );\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,8BAA8B,OAAA,EAG3C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,qBAAA;AAAA,IACJ,WAAA,EAAa,mDAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,QAAQ,CAAA,CAAA,KACN,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,OAAA,EAAS,MAAA,EAAQ,QAAQ,KAAA,EAAO,aAAA,KAAkB,GAAA,CAAI,KAAA;AAE9D,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,CAAE,CAAA;AAElE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI;AACF,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,KAAK,CAAA,wBAAA,EAA2B,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,MAAM,CAAA,CAAA;AAAA,UACvD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,MAAA,CAAO,SAAA,CAAU;AAAA,cACjC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,YAAA,EAAc,MAAA;AAAA,cACd;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAAA,MACH,SAAS,CAAA,EAAG;AACV,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,iCAAA,EAAoC,MAAM,CAAA,YAAA,EAAe,IAAI,MAC3DC,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,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 { InputError, toError } 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  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:issues:label',\n    description: 'Adds labels to a pull request or issue on GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\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          }),\n        number: z =>\n          z.number({\n            description: 'The pull request or issue number to add labels to',\n          }),\n        labels: z =>\n          z.array(z.string(), {\n            description: 'The labels to add to the pull request or issue',\n          }),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\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 octokitOptions = await getOctokitOptions({\n        integrations,\n        requireScmUserCredentials,\n        credentialsProvider: githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\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        ctx.logger.warn(\n          `Failed: adding labels to issue: '${number}' on repo: '${repo}', ${\n            toError(e).message\n          }`,\n        );\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;AAiCO,SAAS,8BAA8B,OAAA,EAI3C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,qBAAA;AAAA,IACJ,WAAA,EAAa,mDAAA;AAAA,cACbC,mCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,QAAQ,CAAA,CAAA,KACN,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UAClB,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,OAAA,EAAS,MAAA,EAAQ,QAAQ,KAAA,EAAO,aAAA,KAAkB,GAAA,CAAI,KAAA;AAE9D,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAChE,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,MAAM,CAAA,eAAA,EAAkB,IAAI,CAAA,CAAE,CAAA;AAElE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,8CAA8C,CAAA;AAAA,MACrE;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,mBAAA,EAAqB,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AACD,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,IAAI;AACF,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,KAAK,CAAA,wBAAA,EAA2B,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,MAAM,CAAA,CAAA;AAAA,UACvD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,MAAA,CAAO,SAAA,CAAU;AAAA,cACjC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,YAAA,EAAc,MAAA;AAAA,cACd;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAAA,MACH,SAAS,CAAA,EAAG;AACV,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,iCAAA,EAAoC,MAAM,CAAA,YAAA,EAAe,IAAI,MAC3DC,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}