@backstage/plugin-scaffolder-backend-module-github 0.9.12 → 0.9.13

package/dist/actions/githubPagesEnable.cjs.js

@@ -7,7 +7,7 @@ var githubPagesEnable_examples = require('./githubPagesEnable.examples.cjs.js');
 var util = require('../util.cjs.js');
 
 function createGithubPagesEnableAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:pages:enable",
     examples: githubPagesEnable_examples.examples,
@@ -45,6 +45,7 @@ function createGithubPagesEnableAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         token: providedToken,
         host,

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

@@ -1 +1 @@
-{"version":3,"file":"githubPagesEnable.cjs.js","sources":["../../src/actions/githubPagesEnable.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './githubPagesEnable.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Creates a new action that enables GitHub Pages for a repository.\n *\n * @public\n */\nexport function createGithubPagesEnableAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:pages:enable',\n    examples,\n    description: 'Enables GitHub Pages for a repository.',\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        buildType: z =>\n          z\n            .enum(['legacy', 'workflow'], {\n              description:\n                'The GitHub Pages build type - `legacy` or `workflow`. Default is `workflow`',\n            })\n            .default('workflow')\n            .optional(),\n        sourceBranch: z =>\n          z\n            .string({\n              description: 'The GitHub Pages source branch. Default is \"main\"',\n            })\n            .default('main')\n            .optional(),\n        sourcePath: z =>\n          z\n            .enum(['/', '/docs'], {\n              description:\n                'The GitHub Pages source path - \"/\" or \"/docs\". Default is \"/\"',\n            })\n            .default('/')\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 {\n        repoUrl,\n        buildType = 'workflow',\n        sourceBranch = 'main',\n        sourcePath = '/',\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      ctx.logger.info(\n        `Attempting to enable GitHub Pages for ${owner}/${repo} with \"${buildType}\" build type, on source branch \"${sourceBranch}\" and source path \"${sourcePath}\"`,\n      );\n\n      await ctx.checkpoint({\n        key: `enabled.github.pages.${owner}.${repo}`,\n        fn: async () => {\n          await client.request('POST /repos/{owner}/{repo}/pages', {\n            owner: owner,\n            repo: repo,\n            build_type: buildType,\n            source: {\n              branch: sourceBranch,\n              path: sourcePath,\n            },\n            headers: {\n              'X-GitHub-Api-Version': '2022-11-28',\n            },\n          });\n        },\n      });\n\n      ctx.logger.info('Completed enabling GitHub Pages');\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAkCO,SAAS,8BAA8B,OAAA,EAG3C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,qBAAA;AAAA,cACJC,mCAAA;AAAA,IACA,WAAA,EAAa,wCAAA;AAAA,IACb,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,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAK,CAAC,QAAA,EAAU,UAAU,CAAA,EAAG;AAAA,UAC5B,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,UAAU,EAClB,QAAA,EAAS;AAAA,QACd,YAAA,EAAc,CAAA,CAAA,KACZ,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,CAAA,CACA,OAAA,CAAQ,MAAM,EACd,QAAA,EAAS;AAAA,QACd,YAAY,CAAA,CAAA,KACV,CAAA,CACG,KAAK,CAAC,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,UACpB,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,GAAG,EACX,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;AAAA,QACJ,OAAA;AAAA,QACA,SAAA,GAAY,UAAA;AAAA,QACZ,YAAA,GAAe,MAAA;AAAA,QACf,UAAA,GAAa,GAAA;AAAA,QACb,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,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,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACT,CAAA,sCAAA,EAAyC,KAAK,CAAA,CAAA,EAAI,IAAI,UAAU,SAAS,CAAA,gCAAA,EAAmC,YAAY,CAAA,mBAAA,EAAsB,UAAU,CAAA,CAAA;AAAA,OAC1J;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,qBAAA,EAAwB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC1C,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,QAAQ,kCAAA,EAAoC;AAAA,YACvD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,UAAA,EAAY,SAAA;AAAA,YACZ,MAAA,EAAQ;AAAA,cACN,MAAA,EAAQ,YAAA;AAAA,cACR,IAAA,EAAM;AAAA,aACR;AAAA,YACA,OAAA,EAAS;AAAA,cACP,sBAAA,EAAwB;AAAA;AAC1B,WACD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,KAAK,iCAAiC,CAAA;AAAA,IACnD;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubPagesEnable.cjs.js","sources":["../../src/actions/githubPagesEnable.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { examples } from './githubPagesEnable.examples';\nimport { getOctokitOptions } from '../util';\n\n/**\n * Creates a new action that enables GitHub Pages for a repository.\n *\n * @public\n */\nexport function createGithubPagesEnableAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:pages:enable',\n    examples,\n    description: 'Enables GitHub Pages for a repository.',\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        buildType: z =>\n          z\n            .enum(['legacy', 'workflow'], {\n              description:\n                'The GitHub Pages build type - `legacy` or `workflow`. Default is `workflow`',\n            })\n            .default('workflow')\n            .optional(),\n        sourceBranch: z =>\n          z\n            .string({\n              description: 'The GitHub Pages source branch. Default is \"main\"',\n            })\n            .default('main')\n            .optional(),\n        sourcePath: z =>\n          z\n            .enum(['/', '/docs'], {\n              description:\n                'The GitHub Pages source path - \"/\" or \"/docs\". Default is \"/\"',\n            })\n            .default('/')\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 {\n        repoUrl,\n        buildType = 'workflow',\n        sourceBranch = 'main',\n        sourcePath = '/',\n        token: providedToken,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        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      ctx.logger.info(\n        `Attempting to enable GitHub Pages for ${owner}/${repo} with \"${buildType}\" build type, on source branch \"${sourceBranch}\" and source path \"${sourcePath}\"`,\n      );\n\n      await ctx.checkpoint({\n        key: `enabled.github.pages.${owner}.${repo}`,\n        fn: async () => {\n          await client.request('POST /repos/{owner}/{repo}/pages', {\n            owner: owner,\n            repo: repo,\n            build_type: buildType,\n            source: {\n              branch: sourceBranch,\n              path: sourcePath,\n            },\n            headers: {\n              'X-GitHub-Api-Version': '2022-11-28',\n            },\n          });\n        },\n      });\n\n      ctx.logger.info('Completed enabling GitHub Pages');\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAkCO,SAAS,8BAA8B,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,cACJC,mCAAA;AAAA,IACA,WAAA,EAAa,wCAAA;AAAA,IACb,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,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAK,CAAC,QAAA,EAAU,UAAU,CAAA,EAAG;AAAA,UAC5B,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,UAAU,EAClB,QAAA,EAAS;AAAA,QACd,YAAA,EAAc,CAAA,CAAA,KACZ,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,CAAA,CACA,OAAA,CAAQ,MAAM,EACd,QAAA,EAAS;AAAA,QACd,YAAY,CAAA,CAAA,KACV,CAAA,CACG,KAAK,CAAC,GAAA,EAAK,OAAO,CAAA,EAAG;AAAA,UACpB,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,GAAG,EACX,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;AAAA,QACJ,OAAA;AAAA,QACA,SAAA,GAAY,UAAA;AAAA,QACZ,YAAA,GAAe,MAAA;AAAA,QACf,UAAA,GAAa,GAAA;AAAA,QACb,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,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,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACT,CAAA,sCAAA,EAAyC,KAAK,CAAA,CAAA,EAAI,IAAI,UAAU,SAAS,CAAA,gCAAA,EAAmC,YAAY,CAAA,mBAAA,EAAsB,UAAU,CAAA,CAAA;AAAA,OAC1J;AAEA,MAAA,MAAM,IAAI,UAAA,CAAW;AAAA,QACnB,GAAA,EAAK,CAAA,qBAAA,EAAwB,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC1C,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,CAAO,QAAQ,kCAAA,EAAoC;AAAA,YACvD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,UAAA,EAAY,SAAA;AAAA,YACZ,MAAA,EAAQ;AAAA,cACN,MAAA,EAAQ,YAAA;AAAA,cACR,IAAA,EAAM;AAAA,aACR;AAAA,YACA,OAAA,EAAS;AAAA,cACP,sBAAA,EAAwB;AAAA;AAC1B,WACD,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,KAAK,iCAAiC,CAAA;AAAA,IACnD;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubPullRequest.cjs.js

@@ -42,7 +42,8 @@ const createPublishGithubPullRequestAction = (options) => {
     integrations,
     githubCredentialsProvider,
     clientFactory = defaultClientFactory,
-    config
+    config,
+    requireScmUserCredentials
   } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
@@ -152,6 +153,11 @@ const createPublishGithubPullRequestAction = (options) => {
           `No owner provided for host: ${host}, and repo ${repo}`
         );
       }
+      if (requireScmUserCredentials && !providedToken) {
+        throw new errors.InputError(
+          `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`
+        );
+      }
       const client = await clientFactory({
         integrations,
         githubCredentialsProvider,

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

@@ -1 +1 @@
-{"version":3,"file":"githubPullRequest.cjs.js","sources":["../../src/actions/githubPullRequest.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport path from 'node:path';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  SerializedFile,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { CustomErrorBase, InputError } from '@backstage/errors';\nimport {\n  createPullRequest,\n  DELETE_FILE,\n} from 'octokit-plugin-create-pull-request';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubPullRequest.examples';\nimport {\n  LoggerService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { JsonValue } from '@backstage/types';\n\nexport type Encoding = 'utf-8' | 'base64';\n\nclass GithubResponseError extends CustomErrorBase {}\n\nexport const defaultClientFactory: CreateGithubPullRequestActionOptions['clientFactory'] =\n  async ({\n    integrations,\n    githubCredentialsProvider,\n    owner,\n    repo,\n    host = 'github.com',\n    token: providedToken,\n  }) => {\n    const octokitOptions = await getOctokitOptions({\n      integrations,\n      credentialsProvider: githubCredentialsProvider,\n      host,\n      owner,\n      repo,\n      token: providedToken,\n    });\n\n    const OctokitPR = Octokit.plugin(createPullRequest);\n    return new OctokitPR({\n      ...octokitOptions,\n      ...{ throttle: { enabled: false } },\n    });\n  };\n\n/**\n * The options passed to {@link createPublishGithubPullRequestAction} method\n * @public\n */\nexport interface CreateGithubPullRequestActionOptions {\n  /**\n   * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.\n   */\n  integrations: ScmIntegrationRegistry;\n  /**\n   * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.\n   */\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  /**\n   * A method to return the Octokit client with the Pull Request Plugin.\n   */\n  clientFactory?: (input: {\n    integrations: ScmIntegrationRegistry;\n    githubCredentialsProvider?: GithubCredentialsProvider;\n    host: string;\n    owner: string;\n    repo: string;\n    token?: string;\n  }) => Promise<\n    Octokit & {\n      createPullRequest(options: createPullRequest.Options): Promise<{\n        data: {\n          html_url: string;\n          number: number;\n          base: {\n            ref: string;\n          };\n        };\n      } | null>;\n    }\n  >;\n  /**\n   * An instance of {@link @backstage/config#Config} that will be used in the action.\n   */\n  config?: Config;\n}\n\ntype GithubPullRequest = {\n  owner: string;\n  repo: string;\n  number: number;\n};\n\n/**\n * Creates a Github Pull Request action.\n * @public\n */\nexport const createPublishGithubPullRequestAction = (\n  options: CreateGithubPullRequestActionOptions,\n) => {\n  const {\n    integrations,\n    githubCredentialsProvider,\n    clientFactory = defaultClientFactory,\n    config,\n  } = options;\n\n  return createTemplateAction({\n    id: 'publish:github:pull-request',\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        branchName: z =>\n          z.string({\n            description: 'The name for the branch',\n          }),\n        filesToDelete: z =>\n          z\n            .array(z.string(), {\n              description: 'List of files that will be deleted',\n            })\n            .optional(),\n        targetBranchName: z =>\n          z\n            .string({\n              description: 'The target branch name of the pull request',\n            })\n            .optional(),\n        title: z =>\n          z.string({\n            description: 'The name for the pull request',\n          }),\n        description: z =>\n          z.string({\n            description: 'The description of the pull request',\n          }),\n        draft: z =>\n          z\n            .boolean({\n              description: 'Create a draft pull request',\n            })\n            .optional(),\n        sourcePath: z =>\n          z\n            .string({\n              description:\n                'Subdirectory of working directory to copy changes from',\n            })\n            .optional(),\n        targetPath: z =>\n          z\n            .string({\n              description: 'Subdirectory of repository to apply changes to',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n        reviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The users that will be added as reviewers to the pull request',\n            })\n            .optional(),\n        assignees: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The users that will be added as assignees to the pull request',\n            })\n            .optional(),\n        teamReviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The teams that will be added as reviewers to the pull request',\n            })\n            .optional(),\n        commitMessage: z =>\n          z\n            .string({\n              description: 'The commit message for the pull request commit',\n            })\n            .optional(),\n        update: z =>\n          z\n            .boolean({\n              description: 'Update pull request if already exists',\n            })\n            .optional(),\n        forceFork: z =>\n          z\n            .boolean({\n              description: 'Create pull request from a fork',\n            })\n            .optional(),\n        gitAuthorName: z =>\n          z\n            .string({\n              description:\n                'Sets the default author name for the commit. The default value is the authenticated user or `Scaffolder`',\n            })\n            .optional(),\n        gitAuthorEmail: z =>\n          z\n            .string({\n              description:\n                'Sets the default author email for the commit. The default value is the authenticated user or `scaffolder@backstage.io`',\n            })\n            .optional(),\n        forceEmptyGitAuthor: z =>\n          z\n            .boolean({\n              description:\n                'Forces the author to be empty. This is useful when using a Github App, it permit the commit to be verified on Github',\n            })\n            .optional(),\n        createWhenEmpty: z =>\n          z\n            .boolean({\n              description:\n                'Set whether to create pull request when there are no changes to commit. The default value is true. If set to false, remoteUrl is no longer a required output.',\n            })\n            .optional(),\n      },\n      output: {\n        targetBranchName: z =>\n          z.string({\n            description: 'Target branch name of the merge request',\n          }),\n        remoteUrl: z =>\n          z.string({\n            description: 'Link to the pull request in Github',\n          }),\n        pullRequestNumber: z =>\n          z.number({\n            description: 'The pull request number',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branchName,\n        filesToDelete,\n        targetBranchName,\n        title,\n        description,\n        draft,\n        targetPath,\n        sourcePath,\n        token: providedToken,\n        reviewers,\n        assignees,\n        teamReviewers,\n        commitMessage,\n        update,\n        forceFork,\n        gitAuthorEmail,\n        gitAuthorName,\n        forceEmptyGitAuthor,\n        createWhenEmpty,\n      } = ctx.input;\n\n      const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(\n          `No owner provided for host: ${host}, and repo ${repo}`,\n        );\n      }\n\n      const client = await clientFactory({\n        integrations,\n        githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const fileRoot = sourcePath\n        ? resolveSafeChildPath(ctx.workspacePath, sourcePath)\n        : ctx.workspacePath;\n\n      const directoryContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      const determineFileMode = (file: SerializedFile): string => {\n        if (file.symlink) return '120000';\n        if (file.executable) return '100755';\n        return '100644';\n      };\n\n      const determineFileEncoding = (\n        file: SerializedFile,\n      ): 'utf-8' | 'base64' => (file.symlink ? 'utf-8' : 'base64');\n\n      const files = Object.fromEntries([\n        ...directoryContents.map(file => [\n          targetPath ? path.posix.join(targetPath, file.path) : file.path,\n          {\n            // See the properties of tree items\n            // in https://docs.github.com/en/rest/reference/git#trees\n            mode: determineFileMode(file),\n            // Always use base64 encoding where possible to avoid doubling a binary file in size\n            // due to interpreting a binary file as utf-8 and sending github\n            // the utf-8 encoded content. Symlinks are kept as utf-8 to avoid them\n            // being formatted as a series of scrambled characters\n            //\n            // For example, the original gradle-wrapper.jar is 57.8k in https://github.com/kennethzfeng/pull-request-test/pull/5/files.\n            // Its size could be doubled to 98.3K (See https://github.com/kennethzfeng/pull-request-test/pull/4/files)\n            encoding: determineFileEncoding(file),\n            content: file.content.toString(determineFileEncoding(file)),\n          },\n        ]),\n        // order of arrays is important so filesToDelete will overwrite\n        // changes from files above\n        ...(filesToDelete || []).map(filePath => [\n          targetPath ? path.posix.join(targetPath, filePath) : filePath,\n          DELETE_FILE,\n        ]),\n      ]);\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating pull request`);\n        ctx.output('targetBranchName', branchName);\n        ctx.output('remoteUrl', repoUrl);\n        ctx.output('pullRequestNumber', 43);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const createOptions: createPullRequest.Options = {\n          owner,\n          repo,\n          title,\n          changes: [\n            {\n              files,\n              commit:\n                commitMessage ??\n                config?.getOptionalString('scaffolder.defaultCommitMessage') ??\n                title,\n            },\n          ],\n          body: description,\n          head: branchName,\n          draft,\n          update,\n          forceFork,\n          createWhenEmpty,\n        };\n\n        const gitAuthorInfo = {\n          name:\n            gitAuthorName ??\n            config?.getOptionalString('scaffolder.defaultAuthor.name'),\n          email:\n            gitAuthorEmail ??\n            config?.getOptionalString('scaffolder.defaultAuthor.email'),\n        };\n\n        if (!forceEmptyGitAuthor) {\n          if (gitAuthorInfo.name || gitAuthorInfo.email) {\n            if (Array.isArray(createOptions.changes)) {\n              createOptions.changes = createOptions.changes.map(change => ({\n                ...change,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              }));\n            } else {\n              createOptions.changes = {\n                ...createOptions.changes,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              };\n            }\n          }\n        }\n\n        if (targetBranchName) {\n          createOptions.base = targetBranchName;\n        }\n\n        const pr = await ctx.checkpoint({\n          key: `create.pr.${owner}.${repo}.${branchName}`,\n          fn: async () => {\n            const response = await client.createPullRequest(createOptions);\n            if (!response) {\n              return null;\n            }\n\n            return {\n              base: response?.data.base,\n              html_url: response?.data.html_url,\n              number: response?.data.number,\n            };\n          },\n        });\n\n        if (createWhenEmpty === false && !pr) {\n          ctx.logger.info('No changes to commit, pull request was not created');\n          return;\n        }\n\n        if (!pr) {\n          throw new GithubResponseError('null response from Github');\n        }\n\n        const pullRequestNumber = pr.number;\n        const pullRequest = { owner, repo, number: pullRequestNumber };\n        if (reviewers || teamReviewers) {\n          await requestReviewersOnPullRequest(\n            pullRequest,\n            reviewers,\n            teamReviewers,\n            client,\n            ctx.logger,\n            ctx.checkpoint,\n          );\n        }\n\n        if (assignees) {\n          if (assignees.length > 10) {\n            ctx.logger.warn(\n              'Assignees list is too long, only the first 10 will be used.',\n            );\n          }\n          await addAssigneesToPullRequest(\n            pullRequest,\n            assignees,\n            client,\n            ctx.logger,\n            ctx.checkpoint,\n          );\n        }\n\n        const targetBranch = pr.base.ref;\n        ctx.output('targetBranchName', targetBranch);\n        ctx.output('remoteUrl', pr.html_url);\n        ctx.output('pullRequestNumber', pullRequestNumber);\n      } catch (e) {\n        throw new GithubResponseError('Pull request creation failed', e);\n      }\n    },\n  });\n\n  async function addAssigneesToPullRequest(\n    pr: GithubPullRequest,\n    assignees: string[],\n    client: Octokit,\n    logger: LoggerService,\n    checkpoint: <T extends JsonValue | void>(opts: {\n      key: string;\n      fn: () => Promise<T> | T;\n    }) => Promise<T>,\n  ) {\n    try {\n      await checkpoint({\n        key: `add.assignees.${pr.owner}.${pr.repo}.${pr.number}`,\n        fn: async () => {\n          const result = await client.rest.issues.addAssignees({\n            owner: pr.owner,\n            repo: pr.repo,\n            issue_number: pr.number,\n            assignees,\n          });\n\n          const addedAssignees = result.data.assignees?.join(', ') ?? '';\n\n          logger.info(\n            `Added assignees [${addedAssignees}] to Pull request ${pr.number}`,\n          );\n        },\n      });\n    } catch (e) {\n      logger.error(\n        `Failure when adding assignees to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n\n  async function requestReviewersOnPullRequest(\n    pr: GithubPullRequest,\n    reviewers: string[] | undefined,\n    teamReviewers: string[] | undefined,\n    client: Octokit,\n    logger: LoggerService,\n    checkpoint: <T extends JsonValue | void>(opts: {\n      key: string;\n      fn: () => Promise<T> | T;\n    }) => Promise<T>,\n  ) {\n    try {\n      await checkpoint({\n        key: `request.reviewers.${pr.owner}.${pr.repo}.${pr.number}`,\n        fn: async () => {\n          const result = await client.rest.pulls.requestReviewers({\n            owner: pr.owner,\n            repo: pr.repo,\n            pull_number: pr.number,\n            reviewers,\n            team_reviewers: teamReviewers\n              ? [...new Set(teamReviewers)]\n              : undefined,\n          });\n\n          const addedUsers = result.data.requested_reviewers?.join(', ') ?? '';\n          const addedTeams = result.data.requested_teams?.join(', ') ?? '';\n\n          logger.info(\n            `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`,\n          );\n        },\n      });\n    } catch (e) {\n      logger.error(\n        `Failure when adding reviewers to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n};\n"],"names":["CustomErrorBase","getOctokitOptions","Octokit","createPullRequest","createTemplateAction","examples","parseRepoUrl","InputError","resolveSafeChildPath","serializeDirectoryContents","path","DELETE_FILE"],"mappings":";;;;;;;;;;;;;;;AA4CA,MAAM,4BAA4BA,sBAAA,CAAgB;AAAC;AAE5C,MAAM,uBACX,OAAO;AAAA,EACL,YAAA;AAAA,EACA,yBAAA;AAAA,EACA,KAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA,GAAO,YAAA;AAAA,EACP,KAAA,EAAO;AACT,CAAA,KAAM;AACJ,EAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,IAC7C,YAAA;AAAA,IACA,mBAAA,EAAqB,yBAAA;AAAA,IACrB,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACR,CAAA;AAED,EAAA,MAAM,SAAA,GAAYC,eAAA,CAAQ,MAAA,CAAOC,gDAAiB,CAAA;AAClD,EAAA,OAAO,IAAI,SAAA,CAAU;AAAA,IACnB,GAAG,cAAA;AAAA,IACH,GAAG,EAAE,QAAA,EAAU,EAAE,OAAA,EAAS,OAAM;AAAE,GACnC,CAAA;AACH;AAsDK,MAAM,oCAAA,GAAuC,CAClD,OAAA,KACG;AACH,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,aAAA,GAAgB,oBAAA;AAAA,IAChB;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,OAAOC,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,6BAAA;AAAA,cACJC,mCAAA;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,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,eAAe,CAAA,CAAA,KACb,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,gBAAA,EAAkB,CAAA,CAAA,KAChB,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,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,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;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,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,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,EAAS;AAAA,QACd,eAAe,CAAA,CAAA,KACb,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,cAAA,EAAgB,CAAA,CAAA,KACd,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,mBAAA,EAAqB,CAAA,CAAA,KACnB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,eAAA,EAAiB,CAAA,CAAA,KACf,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,gBAAA,EAAkB,CAAA,CAAA,KAChB,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,iBAAA,EAAmB,CAAA,CAAA,KACjB,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,UAAA;AAAA,QACA,aAAA;AAAA,QACA,gBAAA;AAAA,QACA,KAAA;AAAA,QACA,WAAA;AAAA,QACA,KAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,cAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAO,IAAA,EAAM,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,IAAI,CAAA,WAAA,EAAc,IAAI,CAAA;AAAA,SACvD;AAAA,MACF;AAEA,MAAA,MAAM,MAAA,GAAS,MAAM,aAAA,CAAc;AAAA,QACjC,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AAED,MAAA,MAAM,WAAW,UAAA,GACbC,qCAAA,CAAqB,IAAI,aAAA,EAAe,UAAU,IAClD,GAAA,CAAI,aAAA;AAER,MAAA,MAAM,iBAAA,GAAoB,MAAMC,+CAAA,CAA2B,QAAA,EAAU;AAAA,QACnE,SAAA,EAAW;AAAA,OACZ,CAAA;AAED,MAAA,MAAM,iBAAA,GAAoB,CAAC,IAAA,KAAiC;AAC1D,QAAA,IAAI,IAAA,CAAK,SAAS,OAAO,QAAA;AACzB,QAAA,IAAI,IAAA,CAAK,YAAY,OAAO,QAAA;AAC5B,QAAA,OAAO,QAAA;AAAA,MACT,CAAA;AAEA,MAAA,MAAM,qBAAA,GAAwB,CAC5B,IAAA,KACwB,IAAA,CAAK,UAAU,OAAA,GAAU,QAAA;AAEnD,MAAA,MAAM,KAAA,GAAQ,OAAO,WAAA,CAAY;AAAA,QAC/B,GAAG,iBAAA,CAAkB,GAAA,CAAI,CAAA,IAAA,KAAQ;AAAA,UAC/B,UAAA,GAAaC,sBAAK,KAAA,CAAM,IAAA,CAAK,YAAY,IAAA,CAAK,IAAI,IAAI,IAAA,CAAK,IAAA;AAAA,UAC3D;AAAA;AAAA;AAAA,YAGE,IAAA,EAAM,kBAAkB,IAAI,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAQ5B,QAAA,EAAU,sBAAsB,IAAI,CAAA;AAAA,YACpC,SAAS,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,qBAAA,CAAsB,IAAI,CAAC;AAAA;AAC5D,SACD,CAAA;AAAA;AAAA;AAAA,QAGD,GAAA,CAAI,aAAA,IAAiB,EAAC,EAAG,IAAI,CAAA,QAAA,KAAY;AAAA,UACvC,aAAaA,qBAAA,CAAK,KAAA,CAAM,IAAA,CAAK,UAAA,EAAY,QAAQ,CAAA,GAAI,QAAA;AAAA,UACrDC;AAAA,SACD;AAAA,OACF,CAAA;AAGD,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,2CAAA,CAA6C,CAAA;AAC7D,QAAA,GAAA,CAAI,MAAA,CAAO,oBAAoB,UAAU,CAAA;AACzC,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,OAAO,CAAA;AAC/B,QAAA,GAAA,CAAI,MAAA,CAAO,qBAAqB,EAAE,CAAA;AAClC,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,aAAA,GAA2C;AAAA,UAC/C,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAA,EAAS;AAAA,YACP;AAAA,cACE,KAAA;AAAA,cACA,MAAA,EACE,aAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,iCAAiC,CAAA,IAC3D;AAAA;AACJ,WACF;AAAA,UACA,IAAA,EAAM,WAAA;AAAA,UACN,IAAA,EAAM,UAAA;AAAA,UACN,KAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACF;AAEA,QAAA,MAAM,aAAA,GAAgB;AAAA,UACpB,IAAA,EACE,aAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,+BAA+B,CAAA;AAAA,UAC3D,KAAA,EACE,cAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,gCAAgC;AAAA,SAC9D;AAEA,QAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,UAAA,IAAI,aAAA,CAAc,IAAA,IAAQ,aAAA,CAAc,KAAA,EAAO;AAC7C,YAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,aAAA,CAAc,OAAO,CAAA,EAAG;AACxC,cAAA,aAAA,CAAc,OAAA,GAAU,aAAA,CAAc,OAAA,CAAQ,GAAA,CAAI,CAAA,MAAA,MAAW;AAAA,gBAC3D,GAAG,MAAA;AAAA,gBACH,MAAA,EAAQ;AAAA,kBACN,IAAA,EAAM,cAAc,IAAA,IAAQ,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAA,IAAS;AAAA;AAChC,eACF,CAAE,CAAA;AAAA,YACJ,CAAA,MAAO;AACL,cAAA,aAAA,CAAc,OAAA,GAAU;AAAA,gBACtB,GAAG,aAAA,CAAc,OAAA;AAAA,gBACjB,MAAA,EAAQ;AAAA,kBACN,IAAA,EAAM,cAAc,IAAA,IAAQ,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAA,IAAS;AAAA;AAChC,eACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,QAAA,IAAI,gBAAA,EAAkB;AACpB,UAAA,aAAA,CAAc,IAAA,GAAO,gBAAA;AAAA,QACvB;AAEA,QAAA,MAAM,EAAA,GAAK,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UAC9B,KAAK,CAAA,UAAA,EAAa,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UAC7C,IAAI,YAAY;AACd,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,iBAAA,CAAkB,aAAa,CAAA;AAC7D,YAAA,IAAI,CAAC,QAAA,EAAU;AACb,cAAA,OAAO,IAAA;AAAA,YACT;AAEA,YAAA,OAAO;AAAA,cACL,IAAA,EAAM,UAAU,IAAA,CAAK,IAAA;AAAA,cACrB,QAAA,EAAU,UAAU,IAAA,CAAK,QAAA;AAAA,cACzB,MAAA,EAAQ,UAAU,IAAA,CAAK;AAAA,aACzB;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,IAAI,eAAA,KAAoB,KAAA,IAAS,CAAC,EAAA,EAAI;AACpC,UAAA,GAAA,CAAI,MAAA,CAAO,KAAK,oDAAoD,CAAA;AACpE,UAAA;AAAA,QACF;AAEA,QAAA,IAAI,CAAC,EAAA,EAAI;AACP,UAAA,MAAM,IAAI,oBAAoB,2BAA2B,CAAA;AAAA,QAC3D;AAEA,QAAA,MAAM,oBAAoB,EAAA,CAAG,MAAA;AAC7B,QAAA,MAAM,WAAA,GAAc,EAAE,KAAA,EAAO,IAAA,EAAM,QAAQ,iBAAA,EAAkB;AAC7D,QAAA,IAAI,aAAa,aAAA,EAAe;AAC9B,UAAA,MAAM,6BAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,GAAA,CAAI;AAAA,WACN;AAAA,QACF;AAEA,QAAA,IAAI,SAAA,EAAW;AACb,UAAA,IAAI,SAAA,CAAU,SAAS,EAAA,EAAI;AACzB,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,cACT;AAAA,aACF;AAAA,UACF;AACA,UAAA,MAAM,yBAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,GAAA,CAAI;AAAA,WACN;AAAA,QACF;AAEA,QAAA,MAAM,YAAA,GAAe,GAAG,IAAA,CAAK,GAAA;AAC7B,QAAA,GAAA,CAAI,MAAA,CAAO,oBAAoB,YAAY,CAAA;AAC3C,QAAA,GAAA,CAAI,MAAA,CAAO,WAAA,EAAa,EAAA,CAAG,QAAQ,CAAA;AACnC,QAAA,GAAA,CAAI,MAAA,CAAO,qBAAqB,iBAAiB,CAAA;AAAA,MACnD,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,mBAAA,CAAoB,8BAAA,EAAgC,CAAC,CAAA;AAAA,MACjE;AAAA,IACF;AAAA,GACD,CAAA;AAED,EAAA,eAAe,yBAAA,CACb,EAAA,EACA,SAAA,EACA,MAAA,EACA,QACA,UAAA,EAIA;AACA,IAAA,IAAI;AACF,MAAA,MAAM,UAAA,CAAW;AAAA,QACf,GAAA,EAAK,iBAAiB,EAAA,CAAG,KAAK,IAAI,EAAA,CAAG,IAAI,CAAA,CAAA,EAAI,EAAA,CAAG,MAAM,CAAA,CAAA;AAAA,QACtD,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,IAAA,CAAK,OAAO,YAAA,CAAa;AAAA,YACnD,OAAO,EAAA,CAAG,KAAA;AAAA,YACV,MAAM,EAAA,CAAG,IAAA;AAAA,YACT,cAAc,EAAA,CAAG,MAAA;AAAA,YACjB;AAAA,WACD,CAAA;AAED,UAAA,MAAM,iBAAiB,MAAA,CAAO,IAAA,CAAK,SAAA,EAAW,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAE5D,UAAA,MAAA,CAAO,IAAA;AAAA,YACL,CAAA,iBAAA,EAAoB,cAAc,CAAA,kBAAA,EAAqB,EAAA,CAAG,MAAM,CAAA;AAAA,WAClE;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,eAAe,8BACb,EAAA,EACA,SAAA,EACA,aAAA,EACA,MAAA,EACA,QACA,UAAA,EAIA;AACA,IAAA,IAAI;AACF,MAAA,MAAM,UAAA,CAAW;AAAA,QACf,GAAA,EAAK,qBAAqB,EAAA,CAAG,KAAK,IAAI,EAAA,CAAG,IAAI,CAAA,CAAA,EAAI,EAAA,CAAG,MAAM,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,gBAAA,CAAiB;AAAA,YACtD,OAAO,EAAA,CAAG,KAAA;AAAA,YACV,MAAM,EAAA,CAAG,IAAA;AAAA,YACT,aAAa,EAAA,CAAG,MAAA;AAAA,YAChB,SAAA;AAAA,YACA,cAAA,EAAgB,gBACZ,CAAC,GAAG,IAAI,GAAA,CAAI,aAAa,CAAC,CAAA,GAC1B,KAAA;AAAA,WACL,CAAA;AAED,UAAA,MAAM,aAAa,MAAA,CAAO,IAAA,CAAK,mBAAA,EAAqB,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAClE,UAAA,MAAM,aAAa,MAAA,CAAO,IAAA,CAAK,eAAA,EAAiB,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAE9D,UAAA,MAAA,CAAO,IAAA;AAAA,YACL,gBAAgB,UAAU,CAAA,aAAA,EAAgB,UAAU,CAAA,+BAAA,EAAkC,GAAG,MAAM,CAAA;AAAA,WACjG;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF;;;;;"}
+{"version":3,"file":"githubPullRequest.cjs.js","sources":["../../src/actions/githubPullRequest.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport path from 'node:path';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  SerializedFile,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { CustomErrorBase, InputError } from '@backstage/errors';\nimport {\n  createPullRequest,\n  DELETE_FILE,\n} from 'octokit-plugin-create-pull-request';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubPullRequest.examples';\nimport {\n  LoggerService,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { JsonValue } from '@backstage/types';\n\nexport type Encoding = 'utf-8' | 'base64';\n\nclass GithubResponseError extends CustomErrorBase {}\n\nexport const defaultClientFactory: CreateGithubPullRequestActionOptions['clientFactory'] =\n  async ({\n    integrations,\n    githubCredentialsProvider,\n    owner,\n    repo,\n    host = 'github.com',\n    token: providedToken,\n  }) => {\n    const octokitOptions = await getOctokitOptions({\n      integrations,\n      credentialsProvider: githubCredentialsProvider,\n      host,\n      owner,\n      repo,\n      token: providedToken,\n    });\n\n    const OctokitPR = Octokit.plugin(createPullRequest);\n    return new OctokitPR({\n      ...octokitOptions,\n      ...{ throttle: { enabled: false } },\n    });\n  };\n\n/**\n * The options passed to {@link createPublishGithubPullRequestAction} method\n * @public\n */\nexport interface CreateGithubPullRequestActionOptions {\n  /**\n   * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.\n   */\n  integrations: ScmIntegrationRegistry;\n  /**\n   * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.\n   */\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  /**\n   * Whether this action must use credentials provided through its input.\n   */\n  requireScmUserCredentials?: boolean;\n  /**\n   * A method to return the Octokit client with the Pull Request Plugin.\n   */\n  clientFactory?: (input: {\n    integrations: ScmIntegrationRegistry;\n    githubCredentialsProvider?: GithubCredentialsProvider;\n    host: string;\n    owner: string;\n    repo: string;\n    token?: string;\n  }) => Promise<\n    Octokit & {\n      createPullRequest(options: createPullRequest.Options): Promise<{\n        data: {\n          html_url: string;\n          number: number;\n          base: {\n            ref: string;\n          };\n        };\n      } | null>;\n    }\n  >;\n  /**\n   * An instance of {@link @backstage/config#Config} that will be used in the action.\n   */\n  config?: Config;\n}\n\ntype GithubPullRequest = {\n  owner: string;\n  repo: string;\n  number: number;\n};\n\n/**\n * Creates a Github Pull Request action.\n * @public\n */\nexport const createPublishGithubPullRequestAction = (\n  options: CreateGithubPullRequestActionOptions,\n) => {\n  const {\n    integrations,\n    githubCredentialsProvider,\n    clientFactory = defaultClientFactory,\n    config,\n    requireScmUserCredentials,\n  } = options;\n\n  return createTemplateAction({\n    id: 'publish:github:pull-request',\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        branchName: z =>\n          z.string({\n            description: 'The name for the branch',\n          }),\n        filesToDelete: z =>\n          z\n            .array(z.string(), {\n              description: 'List of files that will be deleted',\n            })\n            .optional(),\n        targetBranchName: z =>\n          z\n            .string({\n              description: 'The target branch name of the pull request',\n            })\n            .optional(),\n        title: z =>\n          z.string({\n            description: 'The name for the pull request',\n          }),\n        description: z =>\n          z.string({\n            description: 'The description of the pull request',\n          }),\n        draft: z =>\n          z\n            .boolean({\n              description: 'Create a draft pull request',\n            })\n            .optional(),\n        sourcePath: z =>\n          z\n            .string({\n              description:\n                'Subdirectory of working directory to copy changes from',\n            })\n            .optional(),\n        targetPath: z =>\n          z\n            .string({\n              description: 'Subdirectory of repository to apply changes to',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitHub',\n            })\n            .optional(),\n        reviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The users that will be added as reviewers to the pull request',\n            })\n            .optional(),\n        assignees: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The users that will be added as assignees to the pull request',\n            })\n            .optional(),\n        teamReviewers: z =>\n          z\n            .array(z.string(), {\n              description:\n                'The teams that will be added as reviewers to the pull request',\n            })\n            .optional(),\n        commitMessage: z =>\n          z\n            .string({\n              description: 'The commit message for the pull request commit',\n            })\n            .optional(),\n        update: z =>\n          z\n            .boolean({\n              description: 'Update pull request if already exists',\n            })\n            .optional(),\n        forceFork: z =>\n          z\n            .boolean({\n              description: 'Create pull request from a fork',\n            })\n            .optional(),\n        gitAuthorName: z =>\n          z\n            .string({\n              description:\n                'Sets the default author name for the commit. The default value is the authenticated user or `Scaffolder`',\n            })\n            .optional(),\n        gitAuthorEmail: z =>\n          z\n            .string({\n              description:\n                'Sets the default author email for the commit. The default value is the authenticated user or `scaffolder@backstage.io`',\n            })\n            .optional(),\n        forceEmptyGitAuthor: z =>\n          z\n            .boolean({\n              description:\n                'Forces the author to be empty. This is useful when using a Github App, it permit the commit to be verified on Github',\n            })\n            .optional(),\n        createWhenEmpty: z =>\n          z\n            .boolean({\n              description:\n                'Set whether to create pull request when there are no changes to commit. The default value is true. If set to false, remoteUrl is no longer a required output.',\n            })\n            .optional(),\n      },\n      output: {\n        targetBranchName: z =>\n          z.string({\n            description: 'Target branch name of the merge request',\n          }),\n        remoteUrl: z =>\n          z.string({\n            description: 'Link to the pull request in Github',\n          }),\n        pullRequestNumber: z =>\n          z.number({\n            description: 'The pull request number',\n          }),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        branchName,\n        filesToDelete,\n        targetBranchName,\n        title,\n        description,\n        draft,\n        targetPath,\n        sourcePath,\n        token: providedToken,\n        reviewers,\n        assignees,\n        teamReviewers,\n        commitMessage,\n        update,\n        forceFork,\n        gitAuthorEmail,\n        gitAuthorName,\n        forceEmptyGitAuthor,\n        createWhenEmpty,\n      } = ctx.input;\n\n      const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError(\n          `No owner provided for host: ${host}, and repo ${repo}`,\n        );\n      }\n\n      if (requireScmUserCredentials && !providedToken) {\n        throw new InputError(\n          `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`,\n        );\n      }\n\n      const client = await clientFactory({\n        integrations,\n        githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n\n      const fileRoot = sourcePath\n        ? resolveSafeChildPath(ctx.workspacePath, sourcePath)\n        : ctx.workspacePath;\n\n      const directoryContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      const determineFileMode = (file: SerializedFile): string => {\n        if (file.symlink) return '120000';\n        if (file.executable) return '100755';\n        return '100644';\n      };\n\n      const determineFileEncoding = (\n        file: SerializedFile,\n      ): 'utf-8' | 'base64' => (file.symlink ? 'utf-8' : 'base64');\n\n      const files = Object.fromEntries([\n        ...directoryContents.map(file => [\n          targetPath ? path.posix.join(targetPath, file.path) : file.path,\n          {\n            // See the properties of tree items\n            // in https://docs.github.com/en/rest/reference/git#trees\n            mode: determineFileMode(file),\n            // Always use base64 encoding where possible to avoid doubling a binary file in size\n            // due to interpreting a binary file as utf-8 and sending github\n            // the utf-8 encoded content. Symlinks are kept as utf-8 to avoid them\n            // being formatted as a series of scrambled characters\n            //\n            // For example, the original gradle-wrapper.jar is 57.8k in https://github.com/kennethzfeng/pull-request-test/pull/5/files.\n            // Its size could be doubled to 98.3K (See https://github.com/kennethzfeng/pull-request-test/pull/4/files)\n            encoding: determineFileEncoding(file),\n            content: file.content.toString(determineFileEncoding(file)),\n          },\n        ]),\n        // order of arrays is important so filesToDelete will overwrite\n        // changes from files above\n        ...(filesToDelete || []).map(filePath => [\n          targetPath ? path.posix.join(targetPath, filePath) : filePath,\n          DELETE_FILE,\n        ]),\n      ]);\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Performing dry run of creating pull request`);\n        ctx.output('targetBranchName', branchName);\n        ctx.output('remoteUrl', repoUrl);\n        ctx.output('pullRequestNumber', 43);\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const createOptions: createPullRequest.Options = {\n          owner,\n          repo,\n          title,\n          changes: [\n            {\n              files,\n              commit:\n                commitMessage ??\n                config?.getOptionalString('scaffolder.defaultCommitMessage') ??\n                title,\n            },\n          ],\n          body: description,\n          head: branchName,\n          draft,\n          update,\n          forceFork,\n          createWhenEmpty,\n        };\n\n        const gitAuthorInfo = {\n          name:\n            gitAuthorName ??\n            config?.getOptionalString('scaffolder.defaultAuthor.name'),\n          email:\n            gitAuthorEmail ??\n            config?.getOptionalString('scaffolder.defaultAuthor.email'),\n        };\n\n        if (!forceEmptyGitAuthor) {\n          if (gitAuthorInfo.name || gitAuthorInfo.email) {\n            if (Array.isArray(createOptions.changes)) {\n              createOptions.changes = createOptions.changes.map(change => ({\n                ...change,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              }));\n            } else {\n              createOptions.changes = {\n                ...createOptions.changes,\n                author: {\n                  name: gitAuthorInfo.name || 'Scaffolder',\n                  email: gitAuthorInfo.email || 'scaffolder@backstage.io',\n                },\n              };\n            }\n          }\n        }\n\n        if (targetBranchName) {\n          createOptions.base = targetBranchName;\n        }\n\n        const pr = await ctx.checkpoint({\n          key: `create.pr.${owner}.${repo}.${branchName}`,\n          fn: async () => {\n            const response = await client.createPullRequest(createOptions);\n            if (!response) {\n              return null;\n            }\n\n            return {\n              base: response?.data.base,\n              html_url: response?.data.html_url,\n              number: response?.data.number,\n            };\n          },\n        });\n\n        if (createWhenEmpty === false && !pr) {\n          ctx.logger.info('No changes to commit, pull request was not created');\n          return;\n        }\n\n        if (!pr) {\n          throw new GithubResponseError('null response from Github');\n        }\n\n        const pullRequestNumber = pr.number;\n        const pullRequest = { owner, repo, number: pullRequestNumber };\n        if (reviewers || teamReviewers) {\n          await requestReviewersOnPullRequest(\n            pullRequest,\n            reviewers,\n            teamReviewers,\n            client,\n            ctx.logger,\n            ctx.checkpoint,\n          );\n        }\n\n        if (assignees) {\n          if (assignees.length > 10) {\n            ctx.logger.warn(\n              'Assignees list is too long, only the first 10 will be used.',\n            );\n          }\n          await addAssigneesToPullRequest(\n            pullRequest,\n            assignees,\n            client,\n            ctx.logger,\n            ctx.checkpoint,\n          );\n        }\n\n        const targetBranch = pr.base.ref;\n        ctx.output('targetBranchName', targetBranch);\n        ctx.output('remoteUrl', pr.html_url);\n        ctx.output('pullRequestNumber', pullRequestNumber);\n      } catch (e) {\n        throw new GithubResponseError('Pull request creation failed', e);\n      }\n    },\n  });\n\n  async function addAssigneesToPullRequest(\n    pr: GithubPullRequest,\n    assignees: string[],\n    client: Octokit,\n    logger: LoggerService,\n    checkpoint: <T extends JsonValue | void>(opts: {\n      key: string;\n      fn: () => Promise<T> | T;\n    }) => Promise<T>,\n  ) {\n    try {\n      await checkpoint({\n        key: `add.assignees.${pr.owner}.${pr.repo}.${pr.number}`,\n        fn: async () => {\n          const result = await client.rest.issues.addAssignees({\n            owner: pr.owner,\n            repo: pr.repo,\n            issue_number: pr.number,\n            assignees,\n          });\n\n          const addedAssignees = result.data.assignees?.join(', ') ?? '';\n\n          logger.info(\n            `Added assignees [${addedAssignees}] to Pull request ${pr.number}`,\n          );\n        },\n      });\n    } catch (e) {\n      logger.error(\n        `Failure when adding assignees to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n\n  async function requestReviewersOnPullRequest(\n    pr: GithubPullRequest,\n    reviewers: string[] | undefined,\n    teamReviewers: string[] | undefined,\n    client: Octokit,\n    logger: LoggerService,\n    checkpoint: <T extends JsonValue | void>(opts: {\n      key: string;\n      fn: () => Promise<T> | T;\n    }) => Promise<T>,\n  ) {\n    try {\n      await checkpoint({\n        key: `request.reviewers.${pr.owner}.${pr.repo}.${pr.number}`,\n        fn: async () => {\n          const result = await client.rest.pulls.requestReviewers({\n            owner: pr.owner,\n            repo: pr.repo,\n            pull_number: pr.number,\n            reviewers,\n            team_reviewers: teamReviewers\n              ? [...new Set(teamReviewers)]\n              : undefined,\n          });\n\n          const addedUsers = result.data.requested_reviewers?.join(', ') ?? '';\n          const addedTeams = result.data.requested_teams?.join(', ') ?? '';\n\n          logger.info(\n            `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`,\n          );\n        },\n      });\n    } catch (e) {\n      logger.error(\n        `Failure when adding reviewers to Pull request ${pr.number}`,\n        e,\n      );\n    }\n  }\n};\n"],"names":["CustomErrorBase","getOctokitOptions","Octokit","createPullRequest","createTemplateAction","examples","parseRepoUrl","InputError","resolveSafeChildPath","serializeDirectoryContents","path","DELETE_FILE"],"mappings":";;;;;;;;;;;;;;;AA4CA,MAAM,4BAA4BA,sBAAA,CAAgB;AAAC;AAE5C,MAAM,uBACX,OAAO;AAAA,EACL,YAAA;AAAA,EACA,yBAAA;AAAA,EACA,KAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA,GAAO,YAAA;AAAA,EACP,KAAA,EAAO;AACT,CAAA,KAAM;AACJ,EAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,IAC7C,YAAA;AAAA,IACA,mBAAA,EAAqB,yBAAA;AAAA,IACrB,IAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACR,CAAA;AAED,EAAA,MAAM,SAAA,GAAYC,eAAA,CAAQ,MAAA,CAAOC,gDAAiB,CAAA;AAClD,EAAA,OAAO,IAAI,SAAA,CAAU;AAAA,IACnB,GAAG,cAAA;AAAA,IACH,GAAG,EAAE,QAAA,EAAU,EAAE,OAAA,EAAS,OAAM;AAAE,GACnC,CAAA;AACH;AA0DK,MAAM,oCAAA,GAAuC,CAClD,OAAA,KACG;AACH,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,yBAAA;AAAA,IACA,aAAA,GAAgB,oBAAA;AAAA,IAChB,MAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,OAAOC,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,6BAAA;AAAA,cACJC,mCAAA;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,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,eAAe,CAAA,CAAA,KACb,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,gBAAA,EAAkB,CAAA,CAAA,KAChB,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,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,CAAA;AAAA,QACH,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;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,WAAW,CAAA,CAAA,KACT,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,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,EAAS;AAAA,QACd,eAAe,CAAA,CAAA,KACb,CAAA,CACG,KAAA,CAAM,CAAA,CAAE,QAAO,EAAG;AAAA,UACjB,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,cAAA,EAAgB,CAAA,CAAA,KACd,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,mBAAA,EAAqB,CAAA,CAAA,KACnB,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,eAAA,EAAiB,CAAA,CAAA,KACf,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,gBAAA,EAAkB,CAAA,CAAA,KAChB,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,iBAAA,EAAmB,CAAA,CAAA,KACjB,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,UAAA;AAAA,QACA,aAAA;AAAA,QACA,gBAAA;AAAA,QACA,KAAA;AAAA,QACA,WAAA;AAAA,QACA,KAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,SAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,cAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAO,IAAA,EAAM,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,IAAI,CAAA,WAAA,EAAc,IAAI,CAAA;AAAA,SACvD;AAAA,MACF;AAEA,MAAA,IAAI,yBAAA,IAA6B,CAAC,aAAA,EAAe;AAC/C,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,yCAAyC,IAAI,CAAA,qDAAA;AAAA,SAC/C;AAAA,MACF;AAEA,MAAA,MAAM,MAAA,GAAS,MAAM,aAAA,CAAc;AAAA,QACjC,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA,EAAO;AAAA,OACR,CAAA;AAED,MAAA,MAAM,WAAW,UAAA,GACbC,qCAAA,CAAqB,IAAI,aAAA,EAAe,UAAU,IAClD,GAAA,CAAI,aAAA;AAER,MAAA,MAAM,iBAAA,GAAoB,MAAMC,+CAAA,CAA2B,QAAA,EAAU;AAAA,QACnE,SAAA,EAAW;AAAA,OACZ,CAAA;AAED,MAAA,MAAM,iBAAA,GAAoB,CAAC,IAAA,KAAiC;AAC1D,QAAA,IAAI,IAAA,CAAK,SAAS,OAAO,QAAA;AACzB,QAAA,IAAI,IAAA,CAAK,YAAY,OAAO,QAAA;AAC5B,QAAA,OAAO,QAAA;AAAA,MACT,CAAA;AAEA,MAAA,MAAM,qBAAA,GAAwB,CAC5B,IAAA,KACwB,IAAA,CAAK,UAAU,OAAA,GAAU,QAAA;AAEnD,MAAA,MAAM,KAAA,GAAQ,OAAO,WAAA,CAAY;AAAA,QAC/B,GAAG,iBAAA,CAAkB,GAAA,CAAI,CAAA,IAAA,KAAQ;AAAA,UAC/B,UAAA,GAAaC,sBAAK,KAAA,CAAM,IAAA,CAAK,YAAY,IAAA,CAAK,IAAI,IAAI,IAAA,CAAK,IAAA;AAAA,UAC3D;AAAA;AAAA;AAAA,YAGE,IAAA,EAAM,kBAAkB,IAAI,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAQ5B,QAAA,EAAU,sBAAsB,IAAI,CAAA;AAAA,YACpC,SAAS,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,qBAAA,CAAsB,IAAI,CAAC;AAAA;AAC5D,SACD,CAAA;AAAA;AAAA;AAAA,QAGD,GAAA,CAAI,aAAA,IAAiB,EAAC,EAAG,IAAI,CAAA,QAAA,KAAY;AAAA,UACvC,aAAaA,qBAAA,CAAK,KAAA,CAAM,IAAA,CAAK,UAAA,EAAY,QAAQ,CAAA,GAAI,QAAA;AAAA,UACrDC;AAAA,SACD;AAAA,OACF,CAAA;AAGD,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,2CAAA,CAA6C,CAAA;AAC7D,QAAA,GAAA,CAAI,MAAA,CAAO,oBAAoB,UAAU,CAAA;AACzC,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,OAAO,CAAA;AAC/B,QAAA,GAAA,CAAI,MAAA,CAAO,qBAAqB,EAAE,CAAA;AAClC,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,aAAA,GAA2C;AAAA,UAC/C,KAAA;AAAA,UACA,IAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAA,EAAS;AAAA,YACP;AAAA,cACE,KAAA;AAAA,cACA,MAAA,EACE,aAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,iCAAiC,CAAA,IAC3D;AAAA;AACJ,WACF;AAAA,UACA,IAAA,EAAM,WAAA;AAAA,UACN,IAAA,EAAM,UAAA;AAAA,UACN,KAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA;AAAA,SACF;AAEA,QAAA,MAAM,aAAA,GAAgB;AAAA,UACpB,IAAA,EACE,aAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,+BAA+B,CAAA;AAAA,UAC3D,KAAA,EACE,cAAA,IACA,MAAA,EAAQ,iBAAA,CAAkB,gCAAgC;AAAA,SAC9D;AAEA,QAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,UAAA,IAAI,aAAA,CAAc,IAAA,IAAQ,aAAA,CAAc,KAAA,EAAO;AAC7C,YAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,aAAA,CAAc,OAAO,CAAA,EAAG;AACxC,cAAA,aAAA,CAAc,OAAA,GAAU,aAAA,CAAc,OAAA,CAAQ,GAAA,CAAI,CAAA,MAAA,MAAW;AAAA,gBAC3D,GAAG,MAAA;AAAA,gBACH,MAAA,EAAQ;AAAA,kBACN,IAAA,EAAM,cAAc,IAAA,IAAQ,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAA,IAAS;AAAA;AAChC,eACF,CAAE,CAAA;AAAA,YACJ,CAAA,MAAO;AACL,cAAA,aAAA,CAAc,OAAA,GAAU;AAAA,gBACtB,GAAG,aAAA,CAAc,OAAA;AAAA,gBACjB,MAAA,EAAQ;AAAA,kBACN,IAAA,EAAM,cAAc,IAAA,IAAQ,YAAA;AAAA,kBAC5B,KAAA,EAAO,cAAc,KAAA,IAAS;AAAA;AAChC,eACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,QAAA,IAAI,gBAAA,EAAkB;AACpB,UAAA,aAAA,CAAc,IAAA,GAAO,gBAAA;AAAA,QACvB;AAEA,QAAA,MAAM,EAAA,GAAK,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UAC9B,KAAK,CAAA,UAAA,EAAa,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UAC7C,IAAI,YAAY;AACd,YAAA,MAAM,QAAA,GAAW,MAAM,MAAA,CAAO,iBAAA,CAAkB,aAAa,CAAA;AAC7D,YAAA,IAAI,CAAC,QAAA,EAAU;AACb,cAAA,OAAO,IAAA;AAAA,YACT;AAEA,YAAA,OAAO;AAAA,cACL,IAAA,EAAM,UAAU,IAAA,CAAK,IAAA;AAAA,cACrB,QAAA,EAAU,UAAU,IAAA,CAAK,QAAA;AAAA,cACzB,MAAA,EAAQ,UAAU,IAAA,CAAK;AAAA,aACzB;AAAA,UACF;AAAA,SACD,CAAA;AAED,QAAA,IAAI,eAAA,KAAoB,KAAA,IAAS,CAAC,EAAA,EAAI;AACpC,UAAA,GAAA,CAAI,MAAA,CAAO,KAAK,oDAAoD,CAAA;AACpE,UAAA;AAAA,QACF;AAEA,QAAA,IAAI,CAAC,EAAA,EAAI;AACP,UAAA,MAAM,IAAI,oBAAoB,2BAA2B,CAAA;AAAA,QAC3D;AAEA,QAAA,MAAM,oBAAoB,EAAA,CAAG,MAAA;AAC7B,QAAA,MAAM,WAAA,GAAc,EAAE,KAAA,EAAO,IAAA,EAAM,QAAQ,iBAAA,EAAkB;AAC7D,QAAA,IAAI,aAAa,aAAA,EAAe;AAC9B,UAAA,MAAM,6BAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,aAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,GAAA,CAAI;AAAA,WACN;AAAA,QACF;AAEA,QAAA,IAAI,SAAA,EAAW;AACb,UAAA,IAAI,SAAA,CAAU,SAAS,EAAA,EAAI;AACzB,YAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,cACT;AAAA,aACF;AAAA,UACF;AACA,UAAA,MAAM,yBAAA;AAAA,YACJ,WAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,GAAA,CAAI;AAAA,WACN;AAAA,QACF;AAEA,QAAA,MAAM,YAAA,GAAe,GAAG,IAAA,CAAK,GAAA;AAC7B,QAAA,GAAA,CAAI,MAAA,CAAO,oBAAoB,YAAY,CAAA;AAC3C,QAAA,GAAA,CAAI,MAAA,CAAO,WAAA,EAAa,EAAA,CAAG,QAAQ,CAAA;AACnC,QAAA,GAAA,CAAI,MAAA,CAAO,qBAAqB,iBAAiB,CAAA;AAAA,MACnD,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,mBAAA,CAAoB,8BAAA,EAAgC,CAAC,CAAA;AAAA,MACjE;AAAA,IACF;AAAA,GACD,CAAA;AAED,EAAA,eAAe,yBAAA,CACb,EAAA,EACA,SAAA,EACA,MAAA,EACA,QACA,UAAA,EAIA;AACA,IAAA,IAAI;AACF,MAAA,MAAM,UAAA,CAAW;AAAA,QACf,GAAA,EAAK,iBAAiB,EAAA,CAAG,KAAK,IAAI,EAAA,CAAG,IAAI,CAAA,CAAA,EAAI,EAAA,CAAG,MAAM,CAAA,CAAA;AAAA,QACtD,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,IAAA,CAAK,OAAO,YAAA,CAAa;AAAA,YACnD,OAAO,EAAA,CAAG,KAAA;AAAA,YACV,MAAM,EAAA,CAAG,IAAA;AAAA,YACT,cAAc,EAAA,CAAG,MAAA;AAAA,YACjB;AAAA,WACD,CAAA;AAED,UAAA,MAAM,iBAAiB,MAAA,CAAO,IAAA,CAAK,SAAA,EAAW,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAE5D,UAAA,MAAA,CAAO,IAAA;AAAA,YACL,CAAA,iBAAA,EAAoB,cAAc,CAAA,kBAAA,EAAqB,EAAA,CAAG,MAAM,CAAA;AAAA,WAClE;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,eAAe,8BACb,EAAA,EACA,SAAA,EACA,aAAA,EACA,MAAA,EACA,QACA,UAAA,EAIA;AACA,IAAA,IAAI;AACF,MAAA,MAAM,UAAA,CAAW;AAAA,QACf,GAAA,EAAK,qBAAqB,EAAA,CAAG,KAAK,IAAI,EAAA,CAAG,IAAI,CAAA,CAAA,EAAI,EAAA,CAAG,MAAM,CAAA,CAAA;AAAA,QAC1D,IAAI,YAAY;AACd,UAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,gBAAA,CAAiB;AAAA,YACtD,OAAO,EAAA,CAAG,KAAA;AAAA,YACV,MAAM,EAAA,CAAG,IAAA;AAAA,YACT,aAAa,EAAA,CAAG,MAAA;AAAA,YAChB,SAAA;AAAA,YACA,cAAA,EAAgB,gBACZ,CAAC,GAAG,IAAI,GAAA,CAAI,aAAa,CAAC,CAAA,GAC1B,KAAA;AAAA,WACL,CAAA;AAED,UAAA,MAAM,aAAa,MAAA,CAAO,IAAA,CAAK,mBAAA,EAAqB,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAClE,UAAA,MAAM,aAAa,MAAA,CAAO,IAAA,CAAK,eAAA,EAAiB,IAAA,CAAK,IAAI,CAAA,IAAK,EAAA;AAE9D,UAAA,MAAA,CAAO,IAAA;AAAA,YACL,gBAAgB,UAAU,CAAA,aAAA,EAAgB,UAAU,CAAA,+BAAA,EAAkC,GAAG,MAAM,CAAA;AAAA,WACjG;AAAA,QACF;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,KAAA;AAAA,QACL,CAAA,8CAAA,EAAiD,GAAG,MAAM,CAAA,CAAA;AAAA,QAC1D;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF;;;;;"}

package/dist/actions/githubRepoCreate.cjs.js

@@ -10,7 +10,7 @@ var outputProperties = require('./outputProperties.cjs.js');
 var githubRepoCreate_examples = require('./githubRepoCreate.examples.cjs.js');
 
 function createGithubRepoCreateAction(options) {
-  const { integrations, githubCredentialsProvider } = options;
+  const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
@@ -59,6 +59,7 @@ function createGithubRepoCreateAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         token: providedToken,
         host,

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

@@ -1 +1 @@
-{"version":3,"file":"githubRepoCreate.cjs.js","sources":["../../src/actions/githubRepoCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { createGithubRepoWithCollaboratorsAndTopics } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoCreate.examples';\n\n/**\n * Creates a new action that initializes a git repository\n *\n * @public\n */\nexport function createGithubRepoCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:repo:create',\n    description: 'Creates a GitHub repository.',\n    examples,\n    schema: {\n      input: {\n        ...inputProps,\n      },\n      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\n        repoVisibility = 'private',\n        deleteBranchOnMerge = false,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        allowUpdateBranch = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        subscribe,\n        token: providedToken,\n        autoInit = undefined,\n        workflowAccess,\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 = await ctx.checkpoint({\n        key: `create.repo.and.topics.${owner}.${repo}`,\n        fn: async () => {\n          const newRepo = await createGithubRepoWithCollaboratorsAndTopics(\n            client,\n            repo,\n            owner,\n            repoVisibility,\n            description,\n            homepage,\n            deleteBranchOnMerge,\n            allowMergeCommit,\n            allowSquashMerge,\n            squashMergeCommitTitle,\n            squashMergeCommitMessage,\n            allowRebaseMerge,\n            allowAutoMerge,\n            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            autoInit,\n            workflowAccess,\n          );\n          return newRepo.clone_url;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps","outputProps.remoteUrl","outputProps.repoContentsUrl","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics"],"mappings":";;;;;;;;;;;AAqCO,SAAS,6BAA6B,OAAA,EAG1C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,oBAAA;AAAA,IACJ,WAAA,EAAa,8BAAA;AAAA,cACbC,kCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,GAAGC;AAAA,OACL;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,WAAWC,0BAAY;AAAA,QACvB,iBAAiBC;AAAY;AAC/B,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,cAAA,GAAiB,SAAA;AAAA,QACjB,mBAAA,GAAsB,KAAA;AAAA,QACtB,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,gBAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,QAAA,GAAW,MAAA;AAAA,QACX;AAAA,UACE,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,SAAA,GAAY,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACrC,GAAA,EAAK,CAAA,uBAAA,EAA0B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC5C,IAAI,YAAY;AACd,UAAA,MAAM,UAAU,MAAMC,kDAAA;AAAA,YACpB,MAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,YACA,cAAA;AAAA,YACA,WAAA;AAAA,YACA,QAAA;AAAA,YACA,mBAAA;AAAA,YACA,gBAAA;AAAA,YACA,gBAAA;AAAA,YACA,sBAAA;AAAA,YACA,wBAAA;AAAA,YACA,gBAAA;AAAA,YACA,cAAA;AAAA,YACA,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,MAAA;AAAA,YACJ,QAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,OAAO,OAAA,CAAQ,SAAA;AAAA,QACjB;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AAAA,IACnC;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubRepoCreate.cjs.js","sources":["../../src/actions/githubRepoCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { createGithubRepoWithCollaboratorsAndTopics } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoCreate.examples';\n\n/**\n * Creates a new action that initializes a git repository\n *\n * @public\n */\nexport function createGithubRepoCreateAction(options: {\n  integrations: ScmIntegrationRegistry;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const { integrations, githubCredentialsProvider, requireScmUserCredentials } =\n    options;\n\n  return createTemplateAction({\n    id: 'github:repo:create',\n    description: 'Creates a GitHub repository.',\n    examples,\n    schema: {\n      input: {\n        ...inputProps,\n      },\n      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\n        repoVisibility = 'private',\n        deleteBranchOnMerge = false,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        allowUpdateBranch = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        subscribe,\n        token: providedToken,\n        autoInit = undefined,\n        workflowAccess,\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 = await ctx.checkpoint({\n        key: `create.repo.and.topics.${owner}.${repo}`,\n        fn: async () => {\n          const newRepo = await createGithubRepoWithCollaboratorsAndTopics(\n            client,\n            repo,\n            owner,\n            repoVisibility,\n            description,\n            homepage,\n            deleteBranchOnMerge,\n            allowMergeCommit,\n            allowSquashMerge,\n            squashMergeCommitTitle,\n            squashMergeCommitMessage,\n            allowRebaseMerge,\n            allowAutoMerge,\n            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            autoInit,\n            workflowAccess,\n          );\n          return newRepo.clone_url;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps","outputProps.remoteUrl","outputProps.repoContentsUrl","parseRepoUrl","InputError","getOctokitOptions","Octokit","createGithubRepoWithCollaboratorsAndTopics"],"mappings":";;;;;;;;;;;AAqCO,SAAS,6BAA6B,OAAA,EAI1C;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,oBAAA;AAAA,IACJ,WAAA,EAAa,8BAAA;AAAA,cACbC,kCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,GAAGC;AAAA,OACL;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,WAAWC,0BAAY;AAAA,QACvB,iBAAiBC;AAAY;AAC/B,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,cAAA,GAAiB,SAAA;AAAA,QACjB,mBAAA,GAAsB,KAAA;AAAA,QACtB,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,gBAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAA,EAAO,aAAA;AAAA,QACP,QAAA,GAAW,MAAA;AAAA,QACX;AAAA,UACE,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,SAAA,GAAY,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACrC,GAAA,EAAK,CAAA,uBAAA,EAA0B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,QAC5C,IAAI,YAAY;AACd,UAAA,MAAM,UAAU,MAAMC,kDAAA;AAAA,YACpB,MAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,YACA,cAAA;AAAA,YACA,WAAA;AAAA,YACA,QAAA;AAAA,YACA,mBAAA;AAAA,YACA,gBAAA;AAAA,YACA,gBAAA;AAAA,YACA,sBAAA;AAAA,YACA,wBAAA;AAAA,YACA,gBAAA;AAAA,YACA,cAAA;AAAA,YACA,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,MAAA;AAAA,YACJ,QAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,OAAO,OAAA,CAAQ,SAAA;AAAA,QACjB;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AAAA,IACnC;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubRepoPush.cjs.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"githubRepoPush.cjs.js","sources":["../../src/actions/githubRepoPush.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { initRepoPushAndProtect } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoPush.examples';\n\n/**\n * Creates a new action that initializes a git repository of the content in the workspace\n * and publishes it to GitHub.\n *\n * @public\n */\nexport function createGithubRepoPushAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, config, githubCredentialsProvider } = options;\n\n  return createTemplateAction({\n    id: 'github:repo:push',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        restrictions: inputProps.restrictions,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        defaultBranch: inputProps.defaultBranch,\n        protectDefaultBranch: inputProps.protectDefaultBranch,\n        protectEnforceAdmins: inputProps.protectEnforceAdmins,\n        gitCommitMessage: inputProps.gitCommitMessage,\n        gitAuthorName: inputProps.gitAuthorName,\n        gitAuthorEmail: inputProps.gitAuthorEmail,\n        sourcePath: inputProps.sourcePath,\n        token: inputProps.token,\n        requiredCommitSigning: inputProps.requiredCommitSigning,\n        requiredLinearHistory: inputProps.requiredLinearHistory,\n      },\n      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n        commitHash: outputProps.commitHash,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        defaultBranch = 'main',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        gitCommitMessage = 'initial commit',\n        gitAuthorName,\n        gitAuthorEmail,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount = 1,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        token: providedToken,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        host,\n        owner,\n        repo,\n      });\n\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      const targetRepo = await client.rest.repos.get({ owner, repo });\n\n      const remoteUrl = targetRepo.data.clone_url;\n      const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;\n\n      const commitHash = await ctx.checkpoint({\n        key: `init.repo.publish.${owner}.${client}.${repo}`,\n        fn: async () => {\n          const { commitHash: hash } = await initRepoPushAndProtect(\n            remoteUrl,\n            octokitOptions.auth,\n            ctx.workspacePath,\n            ctx.input.sourcePath,\n            defaultBranch,\n            protectDefaultBranch,\n            protectEnforceAdmins,\n            owner,\n            client,\n            repo,\n            requireCodeOwnerReviews,\n            bypassPullRequestAllowances,\n            requiredApprovingReviewCount,\n            restrictions,\n            requiredStatusCheckContexts,\n            requireBranchesToBeUpToDate,\n            requiredConversationResolution,\n            requireLastPushApproval,\n            config,\n            ctx.logger,\n            gitCommitMessage,\n            gitAuthorName,\n            gitAuthorEmail,\n            dismissStaleReviews,\n            requiredCommitSigning,\n            requiredLinearHistory,\n          );\n          return hash;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n      ctx.output('commitHash', commitHash);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.sourcePath","inputProps.token","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","outputProps.remoteUrl","outputProps.repoContentsUrl","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AAuCO,SAAS,2BAA2B,OAAA,EAIxC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,MAAA,EAAQ,yBAAA,EAA0B,GAAI,OAAA;AAE5D,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,kBAAA;AAAA,IACJ,WAAA,EACE,mFAAA;AAAA,cACFC,gCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,8BAA8BC,4CAAW;AAAA,QACzC,cAAcC,4BAAW;AAAA,QACzB,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,eAAeC,6BAAW;AAAA,QAC1B,sBAAsBC,oCAAW;AAAA,QACjC,sBAAsBC,oCAAW;AAAA,QACjC,kBAAkBC,gCAAW;AAAA,QAC7B,eAAeC,6BAAW;AAAA,QAC1B,gBAAgBC,8BAAW;AAAA,QAC3B,YAAYC,0BAAW;AAAA,QACvB,OAAOC,qBAAW;AAAA,QAClB,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC;AAAW,OACpC;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,aAAA,GAAgB,MAAA;AAAA,QAChB,oBAAA,GAAuB,IAAA;AAAA,QACvB,oBAAA,GAAuB,IAAA;AAAA,QACvB,gBAAA,GAAmB,gBAAA;AAAA,QACnB,aAAA;AAAA,QACA,cAAA;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,KAAA,EAAO,aAAA;AAAA,QACP,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;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI,EAAE,KAAA,EAAO,IAAA,EAAM,CAAA;AAE9D,MAAA,MAAM,SAAA,GAAY,WAAW,IAAA,CAAK,SAAA;AAClC,MAAA,MAAM,kBAAkB,CAAA,EAAG,UAAA,CAAW,IAAA,CAAK,QAAQ,SAAS,aAAa,CAAA,CAAA;AAEzE,MAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACtC,KAAK,CAAA,kBAAA,EAAqB,KAAK,CAAA,CAAA,EAAI,MAAM,IAAI,IAAI,CAAA,CAAA;AAAA,QACjD,IAAI,YAAY;AACd,UAAA,MAAM,EAAE,UAAA,EAAY,IAAA,EAAK,GAAI,MAAMC,8BAAA;AAAA,YACjC,SAAA;AAAA,YACA,cAAA,CAAe,IAAA;AAAA,YACf,GAAA,CAAI,aAAA;AAAA,YACJ,IAAI,KAAA,CAAM,UAAA;AAAA,YACV,aAAA;AAAA,YACA,oBAAA;AAAA,YACA,oBAAA;AAAA,YACA,KAAA;AAAA,YACA,MAAA;AAAA,YACA,IAAA;AAAA,YACA,uBAAA;AAAA,YACA,2BAAA;AAAA,YACA,4BAAA;AAAA,YACA,YAAA;AAAA,YACA,2BAAA;AAAA,YACA,2BAAA;AAAA,YACA,8BAAA;AAAA,YACA,uBAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,gBAAA;AAAA,YACA,aAAA;AAAA,YACA,cAAA;AAAA,YACA,mBAAA;AAAA,YACA,qBAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,OAAO,IAAA;AAAA,QACT;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAA,GAAA,CAAI,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAC7C,MAAA,GAAA,CAAI,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA,IACrC;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubRepoPush.cjs.js","sources":["../../src/actions/githubRepoPush.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { initRepoPushAndProtect } from './helpers';\nimport { getOctokitOptions } from '../util';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './githubRepoPush.examples';\n\n/**\n * Creates a new action that initializes a git repository of the content in the workspace\n * and publishes it to GitHub.\n *\n * @public\n */\nexport function createGithubRepoPushAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const {\n    integrations,\n    config,\n    githubCredentialsProvider,\n    requireScmUserCredentials,\n  } = options;\n\n  return createTemplateAction({\n    id: 'github:repo:push',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        repoUrl: inputProps.repoUrl,\n        requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n        dismissStaleReviews: inputProps.dismissStaleReviews,\n        requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n        bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n        requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n        restrictions: inputProps.restrictions,\n        requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n        requiredConversationResolution:\n          inputProps.requiredConversationResolution,\n        requireLastPushApproval: inputProps.requireLastPushApproval,\n        defaultBranch: inputProps.defaultBranch,\n        protectDefaultBranch: inputProps.protectDefaultBranch,\n        protectEnforceAdmins: inputProps.protectEnforceAdmins,\n        gitCommitMessage: inputProps.gitCommitMessage,\n        gitAuthorName: inputProps.gitAuthorName,\n        gitAuthorEmail: inputProps.gitAuthorEmail,\n        sourcePath: inputProps.sourcePath,\n        token: inputProps.token,\n        requiredCommitSigning: inputProps.requiredCommitSigning,\n        requiredLinearHistory: inputProps.requiredLinearHistory,\n      },\n      output: {\n        remoteUrl: outputProps.remoteUrl,\n        repoContentsUrl: outputProps.repoContentsUrl,\n        commitHash: outputProps.commitHash,\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        defaultBranch = 'main',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        gitCommitMessage = 'initial commit',\n        gitAuthorName,\n        gitAuthorEmail,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount = 1,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        token: providedToken,\n        requiredCommitSigning = false,\n        requiredLinearHistory = false,\n      } = ctx.input;\n\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        requireScmUserCredentials,\n        credentialsProvider: githubCredentialsProvider,\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      const targetRepo = await client.rest.repos.get({ owner, repo });\n\n      const remoteUrl = targetRepo.data.clone_url;\n      const repoContentsUrl = `${targetRepo.data.html_url}/blob/${defaultBranch}`;\n\n      const commitHash = await ctx.checkpoint({\n        key: `init.repo.publish.${owner}.${client}.${repo}`,\n        fn: async () => {\n          const { commitHash: hash } = await initRepoPushAndProtect(\n            remoteUrl,\n            octokitOptions.auth,\n            ctx.workspacePath,\n            ctx.input.sourcePath,\n            defaultBranch,\n            protectDefaultBranch,\n            protectEnforceAdmins,\n            owner,\n            client,\n            repo,\n            requireCodeOwnerReviews,\n            bypassPullRequestAllowances,\n            requiredApprovingReviewCount,\n            restrictions,\n            requiredStatusCheckContexts,\n            requireBranchesToBeUpToDate,\n            requiredConversationResolution,\n            requireLastPushApproval,\n            config,\n            ctx.logger,\n            gitCommitMessage,\n            gitAuthorName,\n            gitAuthorEmail,\n            dismissStaleReviews,\n            requiredCommitSigning,\n            requiredLinearHistory,\n          );\n          return hash;\n        },\n      });\n\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n      ctx.output('commitHash', commitHash);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.sourcePath","inputProps.token","inputProps.requiredCommitSigning","inputProps.requiredLinearHistory","outputProps.remoteUrl","outputProps.repoContentsUrl","outputProps.commitHash","parseRepoUrl","InputError","getOctokitOptions","Octokit","initRepoPushAndProtect"],"mappings":";;;;;;;;;;;AAuCO,SAAS,2BAA2B,OAAA,EAKxC;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,kBAAA;AAAA,IACJ,WAAA,EACE,mFAAA;AAAA,cACFC,gCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,SAASC,uBAAW;AAAA,QACpB,yBAAyBC,uCAAW;AAAA,QACpC,qBAAqBC,mCAAW;AAAA,QAChC,6BAA6BC,2CAAW;AAAA,QACxC,6BAA6BC,2CAAW;AAAA,QACxC,8BAA8BC,4CAAW;AAAA,QACzC,cAAcC,4BAAW;AAAA,QACzB,6BAA6BC,2CAAW;AAAA,QACxC,gCACEC,8CAAW;AAAA,QACb,yBAAyBC,uCAAW;AAAA,QACpC,eAAeC,6BAAW;AAAA,QAC1B,sBAAsBC,oCAAW;AAAA,QACjC,sBAAsBC,oCAAW;AAAA,QACjC,kBAAkBC,gCAAW;AAAA,QAC7B,eAAeC,6BAAW;AAAA,QAC1B,gBAAgBC,8BAAW;AAAA,QAC3B,YAAYC,0BAAW;AAAA,QACvB,OAAOC,qBAAW;AAAA,QAClB,uBAAuBC,qCAAW;AAAA,QAClC,uBAAuBC;AAAW,OACpC;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,aAAA,GAAgB,MAAA;AAAA,QAChB,oBAAA,GAAuB,IAAA;AAAA,QACvB,oBAAA,GAAuB,IAAA;AAAA,QACvB,gBAAA,GAAmB,gBAAA;AAAA,QACnB,aAAA;AAAA,QACA,cAAA;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,KAAA,EAAO,aAAA;AAAA,QACP,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;AAED,MAAA,MAAM,MAAA,GAAS,IAAIC,eAAA,CAAQ;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAA,CAAI;AAAA,OACV,CAAA;AAED,MAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,GAAA,CAAI,EAAE,KAAA,EAAO,IAAA,EAAM,CAAA;AAE9D,MAAA,MAAM,SAAA,GAAY,WAAW,IAAA,CAAK,SAAA;AAClC,MAAA,MAAM,kBAAkB,CAAA,EAAG,UAAA,CAAW,IAAA,CAAK,QAAQ,SAAS,aAAa,CAAA,CAAA;AAEzE,MAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACtC,KAAK,CAAA,kBAAA,EAAqB,KAAK,CAAA,CAAA,EAAI,MAAM,IAAI,IAAI,CAAA,CAAA;AAAA,QACjD,IAAI,YAAY;AACd,UAAA,MAAM,EAAE,UAAA,EAAY,IAAA,EAAK,GAAI,MAAMC,8BAAA;AAAA,YACjC,SAAA;AAAA,YACA,cAAA,CAAe,IAAA;AAAA,YACf,GAAA,CAAI,aAAA;AAAA,YACJ,IAAI,KAAA,CAAM,UAAA;AAAA,YACV,aAAA;AAAA,YACA,oBAAA;AAAA,YACA,oBAAA;AAAA,YACA,KAAA;AAAA,YACA,MAAA;AAAA,YACA,IAAA;AAAA,YACA,uBAAA;AAAA,YACA,2BAAA;AAAA,YACA,4BAAA;AAAA,YACA,YAAA;AAAA,YACA,2BAAA;AAAA,YACA,2BAAA;AAAA,YACA,8BAAA;AAAA,YACA,uBAAA;AAAA,YACA,MAAA;AAAA,YACA,GAAA,CAAI,MAAA;AAAA,YACJ,gBAAA;AAAA,YACA,aAAA;AAAA,YACA,cAAA;AAAA,YACA,mBAAA;AAAA,YACA,qBAAA;AAAA,YACA;AAAA,WACF;AACA,UAAA,OAAO,IAAA;AAAA,QACT;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,aAAa,SAAS,CAAA;AACjC,MAAA,GAAA,CAAI,MAAA,CAAO,mBAAmB,eAAe,CAAA;AAC7C,MAAA,GAAA,CAAI,MAAA,CAAO,cAAc,UAAU,CAAA;AAAA,IACrC;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/githubWebhook.cjs.js

@@ -8,7 +8,12 @@ var util = require('../util.cjs.js');
 var githubWebhook_examples = require('./githubWebhook.examples.cjs.js');
 
 function createGithubWebhookAction(options) {
-  const { integrations, defaultWebhookSecret, githubCredentialsProvider } = options;
+  const {
+    integrations,
+    defaultWebhookSecret,
+    githubCredentialsProvider,
+    requireScmUserCredentials
+  } = options;
   const eventNames = webhooks.emitterEventNames.filter((event) => !event.includes("."));
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
@@ -66,6 +71,7 @@ function createGithubWebhookAction(options) {
       }
       const octokitOptions = await util.getOctokitOptions({
         integrations,
+        requireScmUserCredentials,
         credentialsProvider: githubCredentialsProvider,
         host,
         owner,

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

@@ -1 +1 @@
-{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { InputError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, defaultWebhookSecret, githubCredentialsProvider } =\n    options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository 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 new repository name and `owner` is an organization or username',\n          }),\n        webhookUrl: z =>\n          z.string({\n            description: 'The URL to which the payloads will be delivered',\n          }),\n        webhookSecret: z =>\n          z\n            .string({\n              description:\n                'Webhook secret value. The default can be provided internally in action creation',\n            })\n            .optional(),\n        events: z =>\n          z\n            .union([\n              z.array(z.enum(eventNames as [string, ...string[]]), {\n                description:\n                  'Determines what events the hook is triggered for. Default: `[push]`',\n              }),\n              z.array(z.literal('*'), {\n                description:\n                  'Determines what events the hook is triggered for. Use \"*\" for all events. Default: `[push]`',\n              }),\n            ])\n            .default(['push'])\n            .optional(),\n        active: z =>\n          z\n            .boolean({\n              description:\n                'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n            })\n            .default(true)\n            .optional(),\n        contentType: z =>\n          z\n            .enum(['form', 'json'], {\n              description:\n                'The media type used to serialize the payloads. The default is `form`',\n            })\n            .default('form')\n            .optional(),\n        insecureSsl: z =>\n          z\n            .boolean({\n              description:\n                'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n            })\n            .default(false)\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    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const 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      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n\n        await ctx.checkpoint({\n          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,\n          fn: async () => {\n            await client.rest.repos.createWebhook({\n              owner,\n              repo,\n              config: {\n                url: webhookUrl,\n                content_type: contentType,\n                secret: webhookSecret,\n                insecure_ssl,\n              },\n              events,\n              active,\n            });\n          },\n        });\n\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${\n            toError(e).message\n          }`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAAA,EAIvC;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,oBAAA,EAAsB,yBAAA,EAA0B,GACpE,OAAA;AAEF,EAAA,MAAM,UAAA,GAAaA,2BAAkB,MAAA,CAAO,CAAA,KAAA,KAAS,CAAC,KAAA,CAAM,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,gBAAA;AAAA,IACJ,WAAA,EAAa,6CAAA;AAAA,cACbC,+BAAA;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,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,KAAA,CAAM;AAAA,UACL,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,IAAA,CAAK,UAAmC,CAAA,EAAG;AAAA,YACnD,WAAA,EACE;AAAA,WACH,CAAA;AAAA,UACD,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,OAAA,CAAQ,GAAG,CAAA,EAAG;AAAA,YACtB,WAAA,EACE;AAAA,WACH;AAAA,SACF,CAAA,CACA,OAAA,CAAQ,CAAC,MAAM,CAAC,EAChB,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,IAAI,EACZ,QAAA,EAAS;AAAA,QACd,aAAa,CAAA,CAAA,KACX,CAAA,CACG,KAAK,CAAC,MAAA,EAAQ,MAAM,CAAA,EAAG;AAAA,UACtB,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,MAAM,EACd,QAAA,EAAS;AAAA,QACd,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,KAAK,EACb,QAAA,EAAS;AAAA,QACd,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;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAA,GAAgB,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAA,GAAS,IAAA;AAAA,QACT,WAAA,GAAc,MAAA;AAAA,QACd,WAAA,GAAc,KAAA;AAAA,QACd,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAA,CAAE,CAAA;AACpE,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,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;AAGD,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,YAAA,GAAe,cAAc,GAAA,GAAM,GAAA;AAEzC,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,KAAK,CAAA,gBAAA,EAAmB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc;AAAA,cACpC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA,EAAQ;AAAA,gBACN,GAAA,EAAK,UAAA;AAAA,gBACL,YAAA,EAAc,WAAA;AAAA,gBACd,MAAA,EAAQ,aAAA;AAAA,gBACR;AAAA,eACF;AAAA,cACA,MAAA;AAAA,cACA;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,UAAU,CAAA,sBAAA,CAAwB,CAAA;AAAA,MAChE,SAAS,CAAA,EAAG;AACV,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,wBAAA,EAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,MACtDC,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { InputError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n  requireScmUserCredentials?: boolean;\n}) {\n  const {\n    integrations,\n    defaultWebhookSecret,\n    githubCredentialsProvider,\n    requireScmUserCredentials,\n  } = options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository 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 new repository name and `owner` is an organization or username',\n          }),\n        webhookUrl: z =>\n          z.string({\n            description: 'The URL to which the payloads will be delivered',\n          }),\n        webhookSecret: z =>\n          z\n            .string({\n              description:\n                'Webhook secret value. The default can be provided internally in action creation',\n            })\n            .optional(),\n        events: z =>\n          z\n            .union([\n              z.array(z.enum(eventNames as [string, ...string[]]), {\n                description:\n                  'Determines what events the hook is triggered for. Default: `[push]`',\n              }),\n              z.array(z.literal('*'), {\n                description:\n                  'Determines what events the hook is triggered for. Use \"*\" for all events. Default: `[push]`',\n              }),\n            ])\n            .default(['push'])\n            .optional(),\n        active: z =>\n          z\n            .boolean({\n              description:\n                'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n            })\n            .default(true)\n            .optional(),\n        contentType: z =>\n          z\n            .enum(['form', 'json'], {\n              description:\n                'The media type used to serialize the payloads. The default is `form`',\n            })\n            .default('form')\n            .optional(),\n        insecureSsl: z =>\n          z\n            .boolean({\n              description:\n                'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n            })\n            .default(false)\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    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const 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      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n\n        await ctx.checkpoint({\n          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,\n          fn: async () => {\n            await client.rest.repos.createWebhook({\n              owner,\n              repo,\n              config: {\n                url: webhookUrl,\n                content_type: contentType,\n                secret: webhookSecret,\n                insecure_ssl,\n              },\n              events,\n              active,\n            });\n          },\n        });\n\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${\n            toError(e).message\n          }`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","toError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAAA,EAKvC;AACD,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,oBAAA;AAAA,IACA,yBAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,UAAA,GAAaA,2BAAkB,MAAA,CAAO,CAAA,KAAA,KAAS,CAAC,KAAA,CAAM,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,gBAAA;AAAA,IACJ,WAAA,EAAa,6CAAA;AAAA,cACbC,+BAAA;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,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,KAAA,CAAM;AAAA,UACL,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,IAAA,CAAK,UAAmC,CAAA,EAAG;AAAA,YACnD,WAAA,EACE;AAAA,WACH,CAAA;AAAA,UACD,CAAA,CAAE,KAAA,CAAM,CAAA,CAAE,OAAA,CAAQ,GAAG,CAAA,EAAG;AAAA,YACtB,WAAA,EACE;AAAA,WACH;AAAA,SACF,CAAA,CACA,OAAA,CAAQ,CAAC,MAAM,CAAC,EAChB,QAAA,EAAS;AAAA,QACd,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,IAAI,EACZ,QAAA,EAAS;AAAA,QACd,aAAa,CAAA,CAAA,KACX,CAAA,CACG,KAAK,CAAC,MAAA,EAAQ,MAAM,CAAA,EAAG;AAAA,UACtB,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,MAAM,EACd,QAAA,EAAS;AAAA,QACd,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,KAAK,EACb,QAAA,EAAS;AAAA,QACd,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;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAA,GAAgB,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAA,GAAS,IAAA;AAAA,QACT,WAAA,GAAc,MAAA;AAAA,QACd,WAAA,GAAc,KAAA;AAAA,QACd,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAA,CAAE,CAAA;AACpE,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,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;AAGD,MAAA,IAAI,IAAI,QAAA,EAAU;AAChB,QAAA,GAAA,CAAI,MAAA,CAAO,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAClC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,YAAA,GAAe,cAAc,GAAA,GAAM,GAAA;AAEzC,QAAA,MAAM,IAAI,UAAA,CAAW;AAAA,UACnB,KAAK,CAAA,gBAAA,EAAmB,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc;AAAA,cACpC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAA,EAAQ;AAAA,gBACN,GAAA,EAAK,UAAA;AAAA,gBACL,YAAA,EAAc,WAAA;AAAA,gBACd,MAAA,EAAQ,aAAA;AAAA,gBACR;AAAA,eACF;AAAA,cACA,MAAA;AAAA,cACA;AAAA,aACD,CAAA;AAAA,UACH;AAAA,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,UAAU,CAAA,sBAAA,CAAwB,CAAA;AAAA,MAChE,SAAS,CAAA,EAAG;AACV,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,wBAAA,EAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,MACtDC,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -15,6 +15,7 @@ import { OctokitOptions } from '@octokit/core/dist-types/types';
 declare function createGithubActionsDispatchAction(options: {
     integrations: ScmIntegrations;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     workflowId: string;
@@ -35,6 +36,7 @@ declare function createGithubActionsDispatchAction(options: {
 declare function createGithubIssuesLabelAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     number: number;
@@ -51,6 +53,7 @@ declare function createGithubIssuesLabelAction(options: {
 declare function createGithubIssuesCreateAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     title: string;
@@ -72,6 +75,7 @@ declare function createGithubIssuesCreateAction(options: {
 declare function createGithubRepoCreateAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     access?: string | undefined;
@@ -151,6 +155,7 @@ declare function createGithubRepoPushAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     requireCodeOwnerReviews?: boolean | undefined;
@@ -194,6 +199,7 @@ declare function createGithubWebhookAction(options: {
     integrations: ScmIntegrationRegistry;
     defaultWebhookSecret?: string;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     webhookUrl: string;
@@ -214,6 +220,7 @@ declare function createGithubWebhookAction(options: {
  */
 declare function createGithubDeployKeyAction(options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     publicKey: string;
@@ -233,6 +240,7 @@ declare function createGithubDeployKeyAction(options: {
 declare function createGithubEnvironmentAction(options: {
     integrations: ScmIntegrationRegistry;
     catalog: CatalogService;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     name: string;
@@ -265,6 +273,10 @@ interface CreateGithubPullRequestActionOptions {
      * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.
      */
     githubCredentialsProvider?: GithubCredentialsProvider;
+    /**
+     * Whether this action must use credentials provided through its input.
+     */
+    requireScmUserCredentials?: boolean;
     /**
      * A method to return the Octokit client with the Pull Request Plugin.
      */
@@ -332,6 +344,7 @@ declare function createPublishGithubAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     description?: string | undefined;
@@ -405,6 +418,7 @@ declare function createPublishGithubAction(options: {
 declare function createGithubAutolinksAction(options: {
     integrations: ScmIntegrations;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     keyPrefix: string;
@@ -423,6 +437,7 @@ declare function createGithubAutolinksAction(options: {
 declare function createGithubPagesEnableAction(options: {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     buildType?: "legacy" | "workflow" | undefined;
@@ -440,6 +455,7 @@ declare function createGithubPagesEnableAction(options: {
  */
 declare function createGithubBranchProtectionAction(options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     branch?: string | undefined;
@@ -511,6 +527,7 @@ declare function getOctokitClient(octokitOptions: OctokitOptions, logger: Logger
 declare function getOctokitOptions(options: {
     integrations: ScmIntegrationRegistry;
     credentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
     token?: string;
     host: string;
     owner?: string;
@@ -525,6 +542,7 @@ declare function getOctokitOptions(options: {
 declare function getOctokitOptions(options: {
     integrations: ScmIntegrationRegistry;
     credentialsProvider?: GithubCredentialsProvider;
+    requireScmUserCredentials?: boolean;
     token?: string;
     repoUrl: string;
 }): Promise<OctokitOptions>;

package/dist/module.cjs.js

@@ -33,56 +33,73 @@ const githubModule = backendPluginApi.createBackendModule({
       },
       async init({ scaffolder, config, autocomplete: autocomplete$1, catalog }) {
         const integrations = integration.ScmIntegrations.fromConfig(config);
+        const requireScmUserCredentials = config.getOptionalBoolean("scaffolder.requireScmUserCredentials") ?? false;
         const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
         scaffolder.addActions(
           githubActionsDispatch.createGithubActionsDispatchAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubAutolinks.createGithubAutolinksAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubDeployKey.createGithubDeployKeyAction({
-            integrations
+            integrations,
+            requireScmUserCredentials
           }),
           githubEnvironment.createGithubEnvironmentAction({
             integrations,
-            catalog
+            catalog,
+            requireScmUserCredentials
           }),
           githubIssuesLabel.createGithubIssuesLabelAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubIssuesCreate.createGithubIssuesCreateAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubRepoCreate.createGithubRepoCreateAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
+          }),
+          githubRepoPush.createGithubRepoPushAction({
+            integrations,
+            config,
+            requireScmUserCredentials
           }),
-          githubRepoPush.createGithubRepoPushAction({ integrations, config }),
           githubWebhook.createGithubWebhookAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           github.createPublishGithubAction({
             integrations,
             config,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubPullRequest.createPublishGithubPullRequestAction({
             integrations,
             githubCredentialsProvider,
-            config
+            config,
+            requireScmUserCredentials
           }),
           githubPagesEnable.createGithubPagesEnableAction({
             integrations,
-            githubCredentialsProvider
+            githubCredentialsProvider,
+            requireScmUserCredentials
           }),
           githubBranchProtection.createGithubBranchProtectionAction({
-            integrations
+            integrations,
+            requireScmUserCredentials
           })
         );
         autocomplete$1.addAutocompleteProvider({