@backstage/plugin-scaffolder-backend-module-github 0.10.2-next.0 → 0.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # @backstage/plugin-scaffolder-backend-module-github
2
2
 
3
+ ## 0.10.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 1368ad3: Added a `github:repo:rulesets:create` action that creates a ruleset in a GitHub repository. Rules and bypass actors are written in the same format as the GitHub REST API, so any rule type that GitHub supports can be used in templates.
8
+ - 6c43d4f: Validates the `targetPath` input of the `gitlab:repo:push`, `publish:gitlab:merge-request` and `publish:github:pull-request` scaffolder actions, and the `filesToDelete` entries of `publish:github:pull-request`. The values must be relative paths within the target repository; absolute paths and paths containing `..` segments are now rejected, so changes are only applied inside the intended subdirectory of the repository.
9
+ - Updated dependencies
10
+ - @backstage/integration@2.2.0
11
+ - @backstage/backend-plugin-api@1.12.0
12
+ - @backstage/errors@1.4.0
13
+ - @backstage/catalog-model@1.10.3
14
+ - @backstage/config@1.3.11
15
+ - @backstage/plugin-catalog-node@3.0.0
16
+ - @backstage/plugin-scaffolder-node@1.0.0
17
+
18
+ ## 0.10.2-next.1
19
+
20
+ ### Patch Changes
21
+
22
+ - Updated dependencies
23
+ - @backstage/backend-plugin-api@1.12.0-next.1
24
+ - @backstage/errors@1.4.0-next.0
25
+ - @backstage/integration@2.1.4-next.0
26
+ - @backstage/plugin-catalog-node@3.0.0-next.2
27
+ - @backstage/plugin-scaffolder-node@1.0.0-next.2
28
+ - @backstage/catalog-model@1.10.3-next.0
29
+ - @backstage/config@1.3.11-next.0
30
+
3
31
  ## 0.10.2-next.0
4
32
 
5
33
  ### Patch Changes
package/README.md CHANGED
@@ -3,3 +3,22 @@
3
3
  The github module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
4
4
 
5
5
  _This plugin was created through the Backstage CLI_
6
+
7
+ ## Actions
8
+
9
+ - `publish:github`
10
+ - `publish:github:pull-request`
11
+ - `github:actions:dispatch`
12
+ - `github:autolinks:create`
13
+ - `github:branch-protection:create`
14
+ - `github:deployKey:create`
15
+ - `github:environment:create`
16
+ - `github:issues:create`
17
+ - `github:issues:label`
18
+ - `github:pages:enable`
19
+ - `github:repo:create`
20
+ - `github:repo:push`
21
+ - `github:repo:rulesets:create`
22
+ - `github:webhook`
23
+
24
+ Each action's inputs and examples are listed in your Backstage instance at `/create/actions`.
@@ -7,6 +7,7 @@ var errors = require('@backstage/errors');
7
7
  var octokitPluginCreatePullRequest = require('octokit-plugin-create-pull-request');
8
8
  var util = require('../util.cjs.js');
9
9
  var githubPullRequest_examples = require('./githubPullRequest.examples.cjs.js');
10
+ var helpers = require('./helpers.cjs.js');
10
11
  var backendPluginApi = require('@backstage/backend-plugin-api');
11
12
 
12
13
  function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -147,6 +148,12 @@ const createPublishGithubPullRequestAction = (options) => {
147
148
  forceEmptyGitAuthor,
148
149
  createWhenEmpty
149
150
  } = ctx.input;
151
+ if (targetPath) {
152
+ helpers.assertValidTargetPath(targetPath);
153
+ }
154
+ for (const filePath of filesToDelete || []) {
155
+ helpers.assertValidTargetPath(filePath, "filesToDelete entry");
156
+ }
150
157
  const { owner, repo, host } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
151
158
  if (!owner) {
152
159
  throw new errors.InputError(
@@ -1 +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 * 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;;;"}
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 { assertValidTargetPath } from './helpers';\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 if (targetPath) {\n assertValidTargetPath(targetPath);\n }\n for (const filePath of filesToDelete || []) {\n assertValidTargetPath(filePath, 'filesToDelete entry');\n }\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","assertValidTargetPath","parseRepoUrl","InputError","resolveSafeChildPath","serializeDirectoryContents","path","DELETE_FILE"],"mappings":";;;;;;;;;;;;;;;;AA6CA,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,IAAI,UAAA,EAAY;AACd,QAAAC,6BAAA,CAAsB,UAAU,CAAA;AAAA,MAClC;AACA,MAAA,KAAA,MAAW,QAAA,IAAY,aAAA,IAAiB,EAAC,EAAG;AAC1C,QAAAA,6BAAA,CAAsB,UAAU,qBAAqB,CAAA;AAAA,MACvD;AAEA,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;;;"}
@@ -0,0 +1,120 @@
1
+ 'use strict';
2
+
3
+ var errors = require('@backstage/errors');
4
+ var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
5
+ var octokit = require('octokit');
6
+ var githubRulesets_examples = require('./githubRulesets.examples.cjs.js');
7
+ var util = require('../util.cjs.js');
8
+
9
+ function createGithubRepoRulesetsCreateAction(options) {
10
+ const { integrations, githubCredentialsProvider, requireScmUserCredentials } = options;
11
+ return pluginScaffolderNode.createTemplateAction({
12
+ id: "github:repo:rulesets:create",
13
+ description: "Creates a ruleset in a GitHub repository.",
14
+ examples: githubRulesets_examples.examples,
15
+ schema: {
16
+ input: {
17
+ repoUrl: (z) => z.string({
18
+ description: "Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username"
19
+ }),
20
+ name: (z) => z.string({
21
+ description: "The name of the ruleset"
22
+ }),
23
+ target: (z) => z.enum(["branch", "tag"], {
24
+ description: "The target of the ruleset - `branch` or `tag`. Default is `branch`"
25
+ }).default("branch"),
26
+ enforcement: (z) => z.enum(["active", "evaluate", "disabled"], {
27
+ description: "The enforcement level of the ruleset - `active`, `evaluate` or `disabled`. Default is `active`. `evaluate` is not available on all GitHub plans, see https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets"
28
+ }).default("active"),
29
+ conditions: (z) => z.object(
30
+ {
31
+ ref_name: z.object({
32
+ include: z.array(z.string()).optional(),
33
+ exclude: z.array(z.string()).optional()
34
+ }).optional()
35
+ },
36
+ {
37
+ description: "The conditions that determine which refs the ruleset applies to. Ref name patterns also accept `~DEFAULT_BRANCH` and `~ALL`. Without conditions, the ruleset applies to no refs"
38
+ }
39
+ ).optional(),
40
+ rules: (z) => z.array(
41
+ z.object({
42
+ type: z.string(),
43
+ parameters: z.record(z.string(), z.any()).optional()
44
+ }),
45
+ {
46
+ description: "The rules to enforce, in the format of the GitHub REST API, for example `{ type: pull_request, parameters: { ... } }`"
47
+ }
48
+ ).optional(),
49
+ bypassActors: (z) => z.array(
50
+ z.object({
51
+ actor_id: z.number().int().nullable().optional(),
52
+ actor_type: z.string(),
53
+ bypass_mode: z.enum(["always", "pull_request", "exempt"]).optional()
54
+ }),
55
+ {
56
+ description: "The actors that can bypass the ruleset, in the format of the GitHub REST API"
57
+ }
58
+ ).optional(),
59
+ token: (z) => z.string({
60
+ description: "The token to use for authorization to GitHub"
61
+ }).optional()
62
+ },
63
+ output: {
64
+ id: (z) => z.number({
65
+ description: "The ID of the created ruleset"
66
+ })
67
+ }
68
+ },
69
+ async handler(ctx) {
70
+ const {
71
+ repoUrl,
72
+ name,
73
+ target = "branch",
74
+ enforcement = "active",
75
+ conditions,
76
+ rules,
77
+ bypassActors,
78
+ token: providedToken
79
+ } = ctx.input;
80
+ const { host, owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
81
+ if (!owner) {
82
+ throw new errors.InputError(`No owner provided for repo ${repoUrl}`);
83
+ }
84
+ const octokitOptions = await util.getOctokitOptions({
85
+ integrations,
86
+ requireScmUserCredentials,
87
+ credentialsProvider: githubCredentialsProvider,
88
+ token: providedToken,
89
+ host,
90
+ owner,
91
+ repo
92
+ });
93
+ const client = new octokit.Octokit({
94
+ ...octokitOptions,
95
+ log: ctx.logger
96
+ });
97
+ ctx.logger.info(`Creating ruleset "${name}" in ${owner}/${repo}`);
98
+ const id = await ctx.checkpoint({
99
+ key: `create.ruleset.${JSON.stringify([host, owner, repo, name])}`,
100
+ fn: async () => {
101
+ const { data } = await client.rest.repos.createRepoRuleset({
102
+ owner,
103
+ repo,
104
+ name,
105
+ target,
106
+ enforcement,
107
+ conditions,
108
+ rules,
109
+ bypass_actors: bypassActors
110
+ });
111
+ return data.id;
112
+ }
113
+ });
114
+ ctx.output("id", id);
115
+ }
116
+ });
117
+ }
118
+
119
+ exports.createGithubRepoRulesetsCreateAction = createGithubRepoRulesetsCreateAction;
120
+ //# sourceMappingURL=githubRulesets.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"githubRulesets.cjs.js","sources":["../../src/actions/githubRulesets.ts"],"sourcesContent":["/*\n * Copyright 2026 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 {\n createTemplateAction,\n parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { examples } from './githubRulesets.examples';\nimport { getOctokitOptions } from '../util';\n\ntype CreateRepoRulesetParameters = Parameters<\n Octokit['rest']['repos']['createRepoRuleset']\n>[0] & {};\n\n/**\n * Creates a `github:repo:rulesets:create` Scaffolder action that creates a ruleset in a GitHub repository.\n *\n * @public\n */\nexport function createGithubRepoRulesetsCreateAction(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:rulesets:create',\n description: 'Creates a ruleset in a GitHub repository.',\n examples,\n schema: {\n input: {\n repoUrl: z =>\n z.string({\n description:\n 'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the repository name and `owner` is an organization or username',\n }),\n name: z =>\n z.string({\n description: 'The name of the ruleset',\n }),\n target: z =>\n z\n .enum(['branch', 'tag'], {\n description:\n 'The target of the ruleset - `branch` or `tag`. Default is `branch`',\n })\n .default('branch'),\n enforcement: z =>\n z\n .enum(['active', 'evaluate', 'disabled'], {\n description:\n 'The enforcement level of the ruleset - `active`, `evaluate` or `disabled`. Default is `active`. `evaluate` is not available on all GitHub plans, see https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets',\n })\n .default('active'),\n conditions: z =>\n z\n .object(\n {\n ref_name: z\n .object({\n include: z.array(z.string()).optional(),\n exclude: z.array(z.string()).optional(),\n })\n .optional(),\n },\n {\n description:\n 'The conditions that determine which refs the ruleset applies to. Ref name patterns also accept `~DEFAULT_BRANCH` and `~ALL`. Without conditions, the ruleset applies to no refs',\n },\n )\n .optional(),\n rules: z =>\n z\n .array(\n z.object({\n type: z.string(),\n parameters: z.record(z.string(), z.any()).optional(),\n }),\n {\n description:\n 'The rules to enforce, in the format of the GitHub REST API, for example `{ type: pull_request, parameters: { ... } }`',\n },\n )\n .optional(),\n bypassActors: z =>\n z\n .array(\n z.object({\n actor_id: z.number().int().nullable().optional(),\n actor_type: z.string(),\n bypass_mode: z\n .enum(['always', 'pull_request', 'exempt'])\n .optional(),\n }),\n {\n description:\n 'The actors that can bypass the ruleset, in the format of the GitHub REST API',\n },\n )\n .optional(),\n token: z =>\n z\n .string({\n description: 'The token to use for authorization to GitHub',\n })\n .optional(),\n },\n output: {\n id: z =>\n z.number({\n description: 'The ID of the created ruleset',\n }),\n },\n },\n async handler(ctx) {\n const {\n repoUrl,\n name,\n target = 'branch',\n enforcement = 'active',\n conditions,\n rules,\n bypassActors,\n token: providedToken,\n } = ctx.input;\n\n const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n if (!owner) {\n throw new InputError(`No owner provided for repo ${repoUrl}`);\n }\n\n const octokitOptions = await getOctokitOptions({\n integrations,\n requireScmUserCredentials,\n 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(`Creating ruleset \"${name}\" in ${owner}/${repo}`);\n\n const id = await ctx.checkpoint({\n key: `create.ruleset.${JSON.stringify([host, owner, repo, name])}`,\n fn: async () => {\n const { data } = await client.rest.repos.createRepoRuleset({\n owner,\n repo,\n name,\n target,\n enforcement,\n conditions,\n rules: rules as CreateRepoRulesetParameters['rules'],\n bypass_actors:\n bypassActors as CreateRepoRulesetParameters['bypass_actors'],\n });\n return data.id;\n },\n });\n\n ctx.output('id', id);\n },\n });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit"],"mappings":";;;;;;;;AAsCO,SAAS,qCAAqC,OAAA,EAIlD;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA2B,yBAAA,EAA0B,GACzE,OAAA;AAEF,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,6BAAA;AAAA,IACJ,WAAA,EAAa,2CAAA;AAAA,cACbC,gCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EACE;AAAA,SACH,CAAA;AAAA,QACH,IAAA,EAAM,CAAA,CAAA,KACJ,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,QAAQ,CAAA,CAAA,KACN,CAAA,CACG,KAAK,CAAC,QAAA,EAAU,KAAK,CAAA,EAAG;AAAA,UACvB,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,QAAQ,CAAA;AAAA,QACrB,WAAA,EAAa,OACX,CAAA,CACG,IAAA,CAAK,CAAC,QAAA,EAAU,UAAA,EAAY,UAAU,CAAA,EAAG;AAAA,UACxC,WAAA,EACE;AAAA,SACH,CAAA,CACA,OAAA,CAAQ,QAAQ,CAAA;AAAA,QACrB,UAAA,EAAY,OACV,CAAA,CACG,MAAA;AAAA,UACC;AAAA,YACE,QAAA,EAAU,EACP,MAAA,CAAO;AAAA,cACN,SAAS,CAAA,CAAE,KAAA,CAAM,EAAE,MAAA,EAAQ,EAAE,QAAA,EAAS;AAAA,cACtC,SAAS,CAAA,CAAE,KAAA,CAAM,EAAE,MAAA,EAAQ,EAAE,QAAA;AAAS,aACvC,EACA,QAAA;AAAS,WACd;AAAA,UACA;AAAA,YACE,WAAA,EACE;AAAA;AACJ,UAED,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,OACL,CAAA,CACG,KAAA;AAAA,UACC,EAAE,MAAA,CAAO;AAAA,YACP,IAAA,EAAM,EAAE,MAAA,EAAO;AAAA,YACf,UAAA,EAAY,CAAA,CAAE,MAAA,CAAO,CAAA,CAAE,MAAA,IAAU,CAAA,CAAE,GAAA,EAAK,CAAA,CAAE,QAAA;AAAS,WACpD,CAAA;AAAA,UACD;AAAA,YACE,WAAA,EACE;AAAA;AACJ,UAED,QAAA,EAAS;AAAA,QACd,YAAA,EAAc,OACZ,CAAA,CACG,KAAA;AAAA,UACC,EAAE,MAAA,CAAO;AAAA,YACP,QAAA,EAAU,EAAE,MAAA,EAAO,CAAE,KAAI,CAAE,QAAA,GAAW,QAAA,EAAS;AAAA,YAC/C,UAAA,EAAY,EAAE,MAAA,EAAO;AAAA,YACrB,WAAA,EAAa,EACV,IAAA,CAAK,CAAC,UAAU,cAAA,EAAgB,QAAQ,CAAC,CAAA,CACzC,QAAA;AAAS,WACb,CAAA;AAAA,UACD;AAAA,YACE,WAAA,EACE;AAAA;AACJ,UAED,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,EAAA,EAAI,CAAA,CAAA,KACF,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,IAAA;AAAA,QACA,MAAA,GAAS,QAAA;AAAA,QACT,WAAA,GAAc,QAAA;AAAA,QACd,UAAA;AAAA,QACA,KAAA;AAAA,QACA,YAAA;AAAA,QACA,KAAA,EAAO;AAAA,UACL,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,MAAK,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,iBAAA,CAAW,CAAA,2BAAA,EAA8B,OAAO,CAAA,CAAE,CAAA;AAAA,MAC9D;AAEA,MAAA,MAAM,cAAA,GAAiB,MAAMC,sBAAA,CAAkB;AAAA,QAC7C,YAAA;AAAA,QACA,yBAAA;AAAA,QACA,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,KAAK,CAAA,kBAAA,EAAqB,IAAI,QAAQ,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAEhE,MAAA,MAAM,EAAA,GAAK,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QAC9B,GAAA,EAAK,CAAA,eAAA,EAAkB,IAAA,CAAK,SAAA,CAAU,CAAC,MAAM,KAAA,EAAO,IAAA,EAAM,IAAI,CAAC,CAAC,CAAA,CAAA;AAAA,QAChE,IAAI,YAAY;AACd,UAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,iBAAA,CAAkB;AAAA,YACzD,KAAA;AAAA,YACA,IAAA;AAAA,YACA,IAAA;AAAA,YACA,MAAA;AAAA,YACA,WAAA;AAAA,YACA,UAAA;AAAA,YACA,KAAA;AAAA,YACA,aAAA,EACE;AAAA,WACH,CAAA;AACD,UAAA,OAAO,IAAA,CAAK,EAAA;AAAA,QACd;AAAA,OACD,CAAA;AAED,MAAA,GAAA,CAAI,MAAA,CAAO,MAAM,EAAE,CAAA;AAAA,IACrB;AAAA,GACD,CAAA;AACH;;"}
@@ -0,0 +1,127 @@
1
+ 'use strict';
2
+
3
+ var yaml = require('yaml');
4
+
5
+ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
6
+
7
+ var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
8
+
9
+ const examples = [
10
+ {
11
+ description: `Require a pull request with one approval and passing status checks on the repository's default branch.`,
12
+ example: yaml__default.default.stringify({
13
+ steps: [
14
+ {
15
+ action: "github:repo:rulesets:create",
16
+ name: "Protect default branch",
17
+ input: {
18
+ repoUrl: "github.com?repo=repo&owner=owner",
19
+ name: "default-branch",
20
+ conditions: {
21
+ ref_name: {
22
+ include: ["~DEFAULT_BRANCH"],
23
+ exclude: []
24
+ }
25
+ },
26
+ rules: [
27
+ { type: "deletion" },
28
+ { type: "non_fast_forward" },
29
+ {
30
+ type: "pull_request",
31
+ parameters: {
32
+ required_approving_review_count: 1,
33
+ dismiss_stale_reviews_on_push: true,
34
+ require_code_owner_review: false,
35
+ require_last_push_approval: false,
36
+ required_review_thread_resolution: false
37
+ }
38
+ },
39
+ {
40
+ type: "required_status_checks",
41
+ parameters: {
42
+ strict_required_status_checks_policy: true,
43
+ required_status_checks: [{ context: "ci/build" }]
44
+ }
45
+ }
46
+ ]
47
+ }
48
+ }
49
+ ]
50
+ })
51
+ },
52
+ {
53
+ description: `Evaluate a ruleset requiring signed commits on release branches without enforcing it. The evaluate enforcement level is not available on all GitHub plans.`,
54
+ example: yaml__default.default.stringify({
55
+ steps: [
56
+ {
57
+ action: "github:repo:rulesets:create",
58
+ name: "Evaluate signed commits",
59
+ input: {
60
+ repoUrl: "github.com?repo=repo&owner=owner",
61
+ name: "release-signed-commits",
62
+ enforcement: "evaluate",
63
+ conditions: {
64
+ ref_name: {
65
+ include: ["refs/heads/release/*"]
66
+ }
67
+ },
68
+ rules: [{ type: "required_signatures" }]
69
+ }
70
+ }
71
+ ]
72
+ })
73
+ },
74
+ {
75
+ description: `Prevent version tags from being updated or deleted.`,
76
+ example: yaml__default.default.stringify({
77
+ steps: [
78
+ {
79
+ action: "github:repo:rulesets:create",
80
+ name: "Protect version tags",
81
+ input: {
82
+ repoUrl: "github.com?repo=repo&owner=owner",
83
+ name: "version-tags",
84
+ target: "tag",
85
+ conditions: {
86
+ ref_name: {
87
+ include: ["refs/tags/v*"]
88
+ }
89
+ },
90
+ rules: [{ type: "update" }, { type: "deletion" }]
91
+ }
92
+ }
93
+ ]
94
+ })
95
+ },
96
+ {
97
+ description: `Require linear history on all branches, allowing repository admins to bypass the ruleset.`,
98
+ example: yaml__default.default.stringify({
99
+ steps: [
100
+ {
101
+ action: "github:repo:rulesets:create",
102
+ name: "Require linear history",
103
+ input: {
104
+ repoUrl: "github.com?repo=repo&owner=owner",
105
+ name: "linear-history",
106
+ conditions: {
107
+ ref_name: {
108
+ include: ["~ALL"]
109
+ }
110
+ },
111
+ rules: [{ type: "required_linear_history" }],
112
+ bypassActors: [
113
+ {
114
+ actor_id: 5,
115
+ actor_type: "RepositoryRole",
116
+ bypass_mode: "always"
117
+ }
118
+ ]
119
+ }
120
+ }
121
+ ]
122
+ })
123
+ }
124
+ ];
125
+
126
+ exports.examples = examples;
127
+ //# sourceMappingURL=githubRulesets.examples.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"githubRulesets.examples.cjs.js","sources":["../../src/actions/githubRulesets.examples.ts"],"sourcesContent":["/*\n * Copyright 2026 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n {\n description: `Require a pull request with one approval and passing status checks on the repository's default branch.`,\n example: yaml.stringify({\n steps: [\n {\n action: 'github:repo:rulesets:create',\n name: 'Protect default branch',\n input: {\n repoUrl: 'github.com?repo=repo&owner=owner',\n name: 'default-branch',\n conditions: {\n ref_name: {\n include: ['~DEFAULT_BRANCH'],\n exclude: [],\n },\n },\n rules: [\n { type: 'deletion' },\n { type: 'non_fast_forward' },\n {\n type: 'pull_request',\n parameters: {\n required_approving_review_count: 1,\n dismiss_stale_reviews_on_push: true,\n require_code_owner_review: false,\n require_last_push_approval: false,\n required_review_thread_resolution: false,\n },\n },\n {\n type: 'required_status_checks',\n parameters: {\n strict_required_status_checks_policy: true,\n required_status_checks: [{ context: 'ci/build' }],\n },\n },\n ],\n },\n },\n ],\n }),\n },\n {\n description: `Evaluate a ruleset requiring signed commits on release branches without enforcing it. The evaluate enforcement level is not available on all GitHub plans.`,\n example: yaml.stringify({\n steps: [\n {\n action: 'github:repo:rulesets:create',\n name: 'Evaluate signed commits',\n input: {\n repoUrl: 'github.com?repo=repo&owner=owner',\n name: 'release-signed-commits',\n enforcement: 'evaluate',\n conditions: {\n ref_name: {\n include: ['refs/heads/release/*'],\n },\n },\n rules: [{ type: 'required_signatures' }],\n },\n },\n ],\n }),\n },\n {\n description: `Prevent version tags from being updated or deleted.`,\n example: yaml.stringify({\n steps: [\n {\n action: 'github:repo:rulesets:create',\n name: 'Protect version tags',\n input: {\n repoUrl: 'github.com?repo=repo&owner=owner',\n name: 'version-tags',\n target: 'tag',\n conditions: {\n ref_name: {\n include: ['refs/tags/v*'],\n },\n },\n rules: [{ type: 'update' }, { type: 'deletion' }],\n },\n },\n ],\n }),\n },\n {\n description: `Require linear history on all branches, allowing repository admins to bypass the ruleset.`,\n example: yaml.stringify({\n steps: [\n {\n action: 'github:repo:rulesets:create',\n name: 'Require linear history',\n input: {\n repoUrl: 'github.com?repo=repo&owner=owner',\n name: 'linear-history',\n conditions: {\n ref_name: {\n include: ['~ALL'],\n },\n },\n rules: [{ type: 'required_linear_history' }],\n bypassActors: [\n {\n actor_id: 5,\n actor_type: 'RepositoryRole',\n bypass_mode: 'always',\n },\n ],\n },\n },\n ],\n }),\n },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAAA,GAA8B;AAAA,EACzC;AAAA,IACE,WAAA,EAAa,CAAA,sGAAA,CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAA,CAAU;AAAA,MACtB,KAAA,EAAO;AAAA,QACL;AAAA,UACE,MAAA,EAAQ,6BAAA;AAAA,UACR,IAAA,EAAM,wBAAA;AAAA,UACN,KAAA,EAAO;AAAA,YACL,OAAA,EAAS,kCAAA;AAAA,YACT,IAAA,EAAM,gBAAA;AAAA,YACN,UAAA,EAAY;AAAA,cACV,QAAA,EAAU;AAAA,gBACR,OAAA,EAAS,CAAC,iBAAiB,CAAA;AAAA,gBAC3B,SAAS;AAAC;AACZ,aACF;AAAA,YACA,KAAA,EAAO;AAAA,cACL,EAAE,MAAM,UAAA,EAAW;AAAA,cACnB,EAAE,MAAM,kBAAA,EAAmB;AAAA,cAC3B;AAAA,gBACE,IAAA,EAAM,cAAA;AAAA,gBACN,UAAA,EAAY;AAAA,kBACV,+BAAA,EAAiC,CAAA;AAAA,kBACjC,6BAAA,EAA+B,IAAA;AAAA,kBAC/B,yBAAA,EAA2B,KAAA;AAAA,kBAC3B,0BAAA,EAA4B,KAAA;AAAA,kBAC5B,iCAAA,EAAmC;AAAA;AACrC,eACF;AAAA,cACA;AAAA,gBACE,IAAA,EAAM,wBAAA;AAAA,gBACN,UAAA,EAAY;AAAA,kBACV,oCAAA,EAAsC,IAAA;AAAA,kBACtC,sBAAA,EAAwB,CAAC,EAAE,OAAA,EAAS,YAAY;AAAA;AAClD;AACF;AACF;AACF;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAA,EAAa,CAAA,0JAAA,CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAA,CAAU;AAAA,MACtB,KAAA,EAAO;AAAA,QACL;AAAA,UACE,MAAA,EAAQ,6BAAA;AAAA,UACR,IAAA,EAAM,yBAAA;AAAA,UACN,KAAA,EAAO;AAAA,YACL,OAAA,EAAS,kCAAA;AAAA,YACT,IAAA,EAAM,wBAAA;AAAA,YACN,WAAA,EAAa,UAAA;AAAA,YACb,UAAA,EAAY;AAAA,cACV,QAAA,EAAU;AAAA,gBACR,OAAA,EAAS,CAAC,sBAAsB;AAAA;AAClC,aACF;AAAA,YACA,KAAA,EAAO,CAAC,EAAE,IAAA,EAAM,uBAAuB;AAAA;AACzC;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAA,EAAa,CAAA,mDAAA,CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAA,CAAU;AAAA,MACtB,KAAA,EAAO;AAAA,QACL;AAAA,UACE,MAAA,EAAQ,6BAAA;AAAA,UACR,IAAA,EAAM,sBAAA;AAAA,UACN,KAAA,EAAO;AAAA,YACL,OAAA,EAAS,kCAAA;AAAA,YACT,IAAA,EAAM,cAAA;AAAA,YACN,MAAA,EAAQ,KAAA;AAAA,YACR,UAAA,EAAY;AAAA,cACV,QAAA,EAAU;AAAA,gBACR,OAAA,EAAS,CAAC,cAAc;AAAA;AAC1B,aACF;AAAA,YACA,KAAA,EAAO,CAAC,EAAE,IAAA,EAAM,UAAS,EAAG,EAAE,IAAA,EAAM,UAAA,EAAY;AAAA;AAClD;AACF;AACF,KACD;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAA,EAAa,CAAA,yFAAA,CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAA,CAAU;AAAA,MACtB,KAAA,EAAO;AAAA,QACL;AAAA,UACE,MAAA,EAAQ,6BAAA;AAAA,UACR,IAAA,EAAM,wBAAA;AAAA,UACN,KAAA,EAAO;AAAA,YACL,OAAA,EAAS,kCAAA;AAAA,YACT,IAAA,EAAM,gBAAA;AAAA,YACN,UAAA,EAAY;AAAA,cACV,QAAA,EAAU;AAAA,gBACR,OAAA,EAAS,CAAC,MAAM;AAAA;AAClB,aACF;AAAA,YACA,KAAA,EAAO,CAAC,EAAE,IAAA,EAAM,2BAA2B,CAAA;AAAA,YAC3C,YAAA,EAAc;AAAA,cACZ;AAAA,gBACE,QAAA,EAAU,CAAA;AAAA,gBACV,UAAA,EAAY,gBAAA;AAAA,gBACZ,WAAA,EAAa;AAAA;AACf;AACF;AACF;AACF;AACF,KACD;AAAA;AAEL;;"}
@@ -417,7 +417,15 @@ async function validateAccessTeam(client, access) {
417
417
  function getGitCommitMessage(gitCommitMessage, config) {
418
418
  return gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage");
419
419
  }
420
+ function assertValidTargetPath(targetPath, inputName = "targetPath") {
421
+ if (targetPath.startsWith("/") || targetPath.split("/").includes("..")) {
422
+ throw new errors.InputError(
423
+ `Invalid ${inputName} '${targetPath}': must be a relative path within the target repository, without '..' segments`
424
+ );
425
+ }
426
+ }
420
427
 
428
+ exports.assertValidTargetPath = assertValidTargetPath;
421
429
  exports.createGithubRepoWithCollaboratorsAndTopics = createGithubRepoWithCollaboratorsAndTopics;
422
430
  exports.getGitCommitMessage = getGitCommitMessage;
423
431
  exports.initRepoPushAndProtect = initRepoPushAndProtect;
@@ -1 +1 @@
1
- {"version":3,"file":"helpers.cjs.js","sources":["../../src/actions/helpers.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { NotFoundError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { promises as fsPromises, Dirent } from 'node:fs';\n\nimport {\n getRepoSourceDirectory,\n initRepoAndPush,\n} from '@backstage/plugin-scaffolder-node';\n\nimport Sodium from 'libsodium-wrappers';\nimport {\n enableBranchProtectionOnDefaultRepoBranch,\n entityRefToName,\n} from './gitHelpers';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport async function createGithubRepoWithCollaboratorsAndTopics(\n client: Octokit,\n repo: string,\n owner: string,\n repoVisibility: 'private' | 'internal' | 'public' | undefined,\n description: string | undefined,\n homepage: string | undefined,\n deleteBranchOnMerge: boolean,\n allowMergeCommit: boolean,\n allowSquashMerge: boolean,\n squashMergeCommitTitle: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined,\n squashMergeCommitMessage: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK' | undefined,\n allowRebaseMerge: boolean,\n allowAutoMerge: boolean,\n allowUpdateBranch: boolean,\n access: string | undefined,\n collaborators:\n | (\n | {\n user: string;\n access: string;\n }\n | {\n team: string;\n access: string;\n }\n | {\n /** @deprecated This field is deprecated in favor of team */\n username: string;\n access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';\n }\n )[]\n | undefined,\n hasProjects: boolean | undefined,\n hasWiki: boolean | undefined,\n hasIssues: boolean | undefined,\n topics: string[] | undefined,\n repoVariables: { [key: string]: string } | undefined,\n secrets: { [key: string]: string } | undefined,\n oidcCustomization:\n | {\n useDefault: boolean;\n includeClaimKeys?: string[];\n }\n | undefined,\n customProperties: { [key: string]: string | string[] } | undefined,\n subscribe: boolean | undefined,\n logger: LoggerService,\n autoInit?: boolean | undefined,\n workflowAccess?: 'none' | 'organization' | 'user',\n) {\n const user = await client.rest.users.getByUsername({\n username: owner,\n });\n\n if (access?.startsWith(`${owner}/`)) {\n await validateAccessTeam(client, access);\n }\n\n const baseRepoParams = {\n allow_auto_merge: allowAutoMerge,\n allow_merge_commit: allowMergeCommit,\n allow_rebase_merge: allowRebaseMerge,\n allow_squash_merge: allowSquashMerge,\n allow_update_branch: allowUpdateBranch,\n auto_init: autoInit,\n delete_branch_on_merge: deleteBranchOnMerge,\n description,\n has_issues: hasIssues,\n has_projects: hasProjects,\n has_wiki: hasWiki,\n homepage,\n name: repo,\n private: repoVisibility === 'private',\n squash_merge_commit_message: squashMergeCommitMessage,\n squash_merge_commit_title: squashMergeCommitTitle,\n };\n const repoCreationPromise =\n user.data.type === 'Organization'\n ? client.rest.repos.createInOrg({\n ...baseRepoParams,\n // Custom properties only available on org repos\n custom_properties: customProperties,\n org: owner,\n // @ts-ignore https://github.com/octokit/types.ts/issues/522\n visibility: repoVisibility,\n })\n : client.rest.repos.createForAuthenticatedUser(baseRepoParams);\n\n let newRepo;\n\n try {\n newRepo = (await repoCreationPromise).data;\n } catch (e) {\n if (toError(e).message === 'Resource not accessible by integration') {\n logger.warn(\n `The GitHub app or token provided may not have the required permissions to create the ${user.data.type} repository ${owner}/${repo}.`,\n );\n }\n throw new Error(\n `Failed to create the ${user.data.type} repository ${owner}/${repo}, ${\n toError(e).message\n }`,\n );\n }\n\n if (access?.startsWith(`${owner}/`)) {\n const [, team] = access.split('/');\n await client.rest.teams.addOrUpdateRepoPermissionsInOrg({\n org: owner,\n team_slug: team,\n owner,\n repo,\n permission: 'admin',\n });\n // No need to add access if it's the person who owns the personal account\n } else if (access && access !== owner) {\n await client.rest.repos.addCollaborator({\n owner,\n repo,\n username: access,\n permission: 'admin',\n });\n }\n\n if (collaborators) {\n for (const collaborator of collaborators) {\n try {\n if ('user' in collaborator) {\n await client.rest.repos.addCollaborator({\n owner,\n repo,\n username: entityRefToName(collaborator.user),\n permission: collaborator.access,\n });\n } else if ('team' in collaborator) {\n await client.rest.teams.addOrUpdateRepoPermissionsInOrg({\n org: owner,\n team_slug: entityRefToName(collaborator.team),\n owner,\n repo,\n permission: collaborator.access,\n });\n }\n } catch (e) {\n const name = extractCollaboratorName(collaborator);\n logger.warn(\n `Skipping ${collaborator.access} access for ${name}, ${\n toError(e).message\n }`,\n );\n }\n }\n }\n\n if (topics) {\n try {\n await client.rest.repos.replaceAllTopics({\n owner,\n repo,\n names: topics.map(t => t.toLowerCase()),\n });\n } catch (e) {\n logger.warn(`Skipping topics ${topics.join(' ')}, ${toError(e).message}`);\n }\n }\n\n for (const [key, value] of Object.entries(repoVariables ?? {})) {\n await client.rest.actions.createRepoVariable({\n owner,\n repo,\n name: key,\n value: value,\n });\n }\n\n if (secrets) {\n const publicKeyResponse = await client.rest.actions.getRepoPublicKey({\n owner,\n repo,\n });\n\n await Sodium.ready;\n const binaryKey = Sodium.from_base64(\n publicKeyResponse.data.key,\n Sodium.base64_variants.ORIGINAL,\n );\n for (const [key, value] of Object.entries(secrets)) {\n const binarySecret = Sodium.from_string(value);\n const encryptedBinarySecret = Sodium.crypto_box_seal(\n binarySecret,\n binaryKey,\n );\n const encryptedBase64Secret = Sodium.to_base64(\n encryptedBinarySecret,\n Sodium.base64_variants.ORIGINAL,\n );\n\n await client.rest.actions.createOrUpdateRepoSecret({\n owner,\n repo,\n secret_name: key,\n encrypted_value: encryptedBase64Secret,\n key_id: publicKeyResponse.data.key_id,\n });\n }\n }\n\n if (oidcCustomization) {\n await client.request(\n 'PUT /repos/{owner}/{repo}/actions/oidc/customization/sub',\n {\n owner,\n repo,\n use_default: oidcCustomization.useDefault,\n include_claim_keys: oidcCustomization.includeClaimKeys,\n },\n );\n }\n\n if (subscribe) {\n await client.rest.activity.setRepoSubscription({\n subscribed: true,\n ignored: false,\n owner,\n repo,\n });\n }\n\n if (workflowAccess) {\n await client.rest.actions.setWorkflowAccessToRepository({\n access_level: workflowAccess,\n owner,\n repo,\n });\n }\n\n return newRepo;\n}\n\nexport async function initRepoPushAndProtect(\n remoteUrl: string,\n password: string,\n workspacePath: string,\n sourcePath: string | undefined,\n defaultBranch: string,\n protectDefaultBranch: boolean,\n enforceAdmins: boolean,\n owner: string,\n client: Octokit,\n repo: string,\n requireCodeOwnerReviews: boolean,\n bypassPullRequestAllowances:\n | {\n users?: string[];\n teams?: string[];\n apps?: string[];\n }\n | undefined,\n requiredApprovingReviewCount: number,\n restrictions:\n | {\n users: string[];\n teams: string[];\n apps?: string[];\n }\n | undefined,\n requiredStatusCheckContexts: string[],\n requireBranchesToBeUpToDate: boolean,\n requiredConversationResolution: boolean,\n requireLastPushApproval: boolean,\n config: Config,\n logger: any,\n gitCommitMessage?: string,\n gitAuthorName?: string,\n gitAuthorEmail?: string,\n dismissStaleReviews?: boolean,\n requiredCommitSigning?: boolean,\n requiredLinearHistory?: boolean,\n): Promise<{ commitHash: string }> {\n const gitAuthorInfo = {\n name: gitAuthorName\n ? gitAuthorName\n : config.getOptionalString('scaffolder.defaultAuthor.name'),\n email: gitAuthorEmail\n ? gitAuthorEmail\n : config.getOptionalString('scaffolder.defaultAuthor.email'),\n };\n\n const commitMessage =\n getGitCommitMessage(gitCommitMessage, config) || 'initial commit';\n\n let commitResult: { commitHash: string };\n\n try {\n commitResult = await initRepoAndPush({\n dir: getRepoSourceDirectory(workspacePath, sourcePath),\n remoteUrl,\n defaultBranch,\n auth: {\n username: 'x-access-token',\n password,\n },\n logger,\n commitMessage,\n gitAuthorInfo,\n });\n } catch (error) {\n const code = (error as NodeJS.ErrnoException).code;\n const causeCode = (\n (error as NodeJS.ErrnoException).cause as\n | NodeJS.ErrnoException\n | undefined\n )?.code;\n const isConnectionError =\n code === 'ECONNRESET' ||\n code === 'ECONNREFUSED' ||\n causeCode === 'ECONNRESET' ||\n causeCode === 'ECONNREFUSED';\n if (isConnectionError) {\n logger.warn(\n `Git push failed with ${code ?? causeCode}, retrying via GitHub API. ` +\n 'This can happen when a network proxy blocks the binary payload ' +\n 'in the git smart HTTP protocol.',\n );\n commitResult = await pushFilesViaGitHubApi({\n dir: getRepoSourceDirectory(workspacePath, sourcePath),\n owner,\n repo,\n client,\n defaultBranch,\n commitMessage,\n logger,\n });\n } else {\n throw error;\n }\n }\n\n if (protectDefaultBranch) {\n try {\n await enableBranchProtectionOnDefaultRepoBranch({\n owner,\n client,\n repoName: repo,\n logger,\n defaultBranch,\n bypassPullRequestAllowances,\n requiredApprovingReviewCount,\n restrictions,\n requireCodeOwnerReviews,\n requiredStatusCheckContexts,\n requireBranchesToBeUpToDate,\n requiredConversationResolution,\n requireLastPushApproval,\n enforceAdmins,\n dismissStaleReviews,\n requiredCommitSigning,\n requiredLinearHistory,\n });\n } catch (e) {\n logger.warn(\n `Skipping: default branch protection on '${repo}', ${\n toError(e).message\n }`,\n );\n }\n }\n\n return { commitHash: commitResult.commitHash };\n}\n\nasync function collectFilesFromDir(\n dirPath: string,\n basePath: string = '',\n rootPath?: string,\n): Promise<{ filePath: string; content: Buffer }[]> {\n const root = rootPath ?? dirPath;\n const entries: Dirent[] = await fsPromises.readdir(dirPath, {\n withFileTypes: true,\n });\n const results: { filePath: string; content: Buffer }[] = [];\n for (const entry of entries) {\n const fullPath = resolveSafeChildPath(\n root,\n basePath ? `${basePath}/${entry.name}` : entry.name,\n );\n const relativePath = basePath ? `${basePath}/${entry.name}` : entry.name;\n if (entry.name === '.git') {\n continue;\n }\n if (entry.isSymbolicLink()) {\n continue;\n }\n if (entry.isDirectory()) {\n results.push(\n ...(await collectFilesFromDir(fullPath, relativePath, root)),\n );\n } else if (entry.isFile()) {\n results.push({\n filePath: relativePath,\n content: await fsPromises.readFile(fullPath),\n });\n }\n }\n return results;\n}\n\nconst CREATE_COMMIT_ON_BRANCH_MUTATION = `\n mutation CreateCommitOnBranch($input: CreateCommitOnBranchInput!) {\n createCommitOnBranch(input: $input) {\n commit {\n oid\n }\n }\n }\n`;\n\nasync function pushFilesViaGitHubApi(input: {\n dir: string;\n owner: string;\n repo: string;\n client: Octokit;\n defaultBranch: string;\n commitMessage: string;\n logger: LoggerService;\n}): Promise<{ commitHash: string }> {\n const { dir, owner, repo, client, defaultBranch, commitMessage, logger } =\n input;\n\n const files = await collectFilesFromDir(dir);\n logger.info(\n `Collected ${files.length} files for push via GraphQL to ${owner}/${repo}#${defaultBranch}`,\n );\n\n if (files.length === 0) {\n throw new Error(\n 'GraphQL API fallback found no files to push. ' +\n 'The workspace directory may be empty.',\n );\n }\n\n const totalRawBytes = files.reduce((sum, f) => sum + f.content.length, 0);\n // base64 expands content by ~4/3; add 1 KB per file for JSON overhead\n const estimatedPayload =\n Math.ceil(totalRawBytes * (4 / 3)) + files.length * 1024;\n const MAX_PAYLOAD_BYTES = 30 * 1024 * 1024; // 30 MB after encoding\n if (estimatedPayload > MAX_PAYLOAD_BYTES) {\n throw new Error(\n `GraphQL API fallback payload too large ` +\n `(${(totalRawBytes / 1024 / 1024).toFixed(1)} MB raw, ` +\n `~${(estimatedPayload / 1024 / 1024).toFixed(1)} MB encoded). ` +\n 'Consider reducing template size or resolving the network issue preventing git push.',\n );\n }\n\n let headOid: string;\n let needsCleanup = false;\n try {\n const { data: ref } = await client.rest.git.getRef({\n owner,\n repo,\n ref: `heads/${defaultBranch}`,\n });\n headOid = ref.object.sha;\n } catch (refError: unknown) {\n const status = (refError as { status?: number }).status;\n if (status !== 404 && status !== 409) {\n throw refError;\n }\n if (status === 404) {\n const { data: repoData } = await client.rest.repos.get({ owner, repo });\n if (repoData.size > 0) {\n throw new Error(\n `Branch '${defaultBranch}' not found in ${owner}/${repo}. ` +\n `The repository exists and its default branch is '${repoData.default_branch}'.`,\n );\n }\n }\n logger.info(\n `No existing HEAD found for ${owner}/${repo}#${defaultBranch} ` +\n `(status ${status}), initializing repository`,\n );\n const { data: init } = await client.rest.repos.createOrUpdateFileContents({\n owner,\n repo,\n path: '.gitkeep',\n message: 'initialize repository',\n content: '',\n branch: defaultBranch,\n });\n headOid = init.commit.sha!;\n needsCleanup = true;\n }\n\n const additions = files.map(file => ({\n path: file.filePath,\n contents: file.content.toString('base64'),\n }));\n\n const fileChanges: {\n additions: typeof additions;\n deletions?: { path: string }[];\n } = {\n additions,\n };\n if (needsCleanup) {\n fileChanges.deletions = [{ path: '.gitkeep' }];\n }\n\n const commitInput = {\n branch: {\n repositoryNameWithOwner: `${owner}/${repo}`,\n branchName: defaultBranch,\n },\n message: { headline: commitMessage },\n fileChanges,\n expectedHeadOid: headOid,\n };\n\n let result: { createCommitOnBranch: { commit: { oid: string } } };\n try {\n result = await client.graphql(CREATE_COMMIT_ON_BRANCH_MUTATION, {\n input: commitInput,\n });\n } catch (commitError: unknown) {\n const msg = String((commitError as Error).message ?? '');\n if (!msg.includes('expectedHeadOid')) {\n throw commitError;\n }\n logger.warn(\n `HEAD OID of ${owner}/${repo}#${defaultBranch} changed since read, retrying GraphQL commit once`,\n );\n const { data: freshRef } = await client.rest.git.getRef({\n owner,\n repo,\n ref: `heads/${defaultBranch}`,\n });\n commitInput.expectedHeadOid = freshRef.object.sha;\n result = await client.graphql(CREATE_COMMIT_ON_BRANCH_MUTATION, {\n input: commitInput,\n });\n }\n\n const commitHash = result.createCommitOnBranch.commit.oid;\n logger.info(\n `Pushed ${files.length} files to ${owner}/${repo}#${defaultBranch} via GitHub GraphQL API (${commitHash})`,\n );\n return { commitHash };\n}\n\nfunction extractCollaboratorName(\n collaborator: { user: string } | { team: string } | { username: string },\n) {\n if ('username' in collaborator) {\n return collaborator.username;\n }\n if ('user' in collaborator) {\n return collaborator.user;\n }\n return collaborator.team;\n}\n\nasync function validateAccessTeam(client: Octokit, access: string) {\n const [org, team_slug] = access.split('/');\n try {\n // Below rule disabled because of a 'getByName' check for a different library\n // incorrectly triggers here.\n // eslint-disable-next-line testing-library/no-await-sync-queries\n await client.rest.teams.getByName({\n org,\n team_slug,\n });\n } catch (e) {\n if (e.response.data.message === 'Not Found') {\n const message = `Received 'Not Found' from the API; one of org:\n ${org} or team: ${team_slug} was not found within GitHub.`;\n throw new NotFoundError(message);\n }\n }\n}\n\nexport function getGitCommitMessage(\n gitCommitMessage: string | undefined,\n config: Config,\n): string | undefined {\n return gitCommitMessage\n ? gitCommitMessage\n : config.getOptionalString('scaffolder.defaultCommitMessage');\n}\n"],"names":["toError","entityRefToName","Sodium","initRepoAndPush","getRepoSourceDirectory","enableBranchProtectionOnDefaultRepoBranch","fsPromises","resolveSafeChildPath","NotFoundError"],"mappings":";;;;;;;;;;;;;AAkCA,eAAsB,0CAAA,CACpB,MAAA,EACA,IAAA,EACA,KAAA,EACA,cAAA,EACA,WAAA,EACA,QAAA,EACA,mBAAA,EACA,gBAAA,EACA,gBAAA,EACA,sBAAA,EACA,wBAAA,EACA,gBAAA,EACA,cAAA,EACA,iBAAA,EACA,MAAA,EACA,aAAA,EAiBA,WAAA,EACA,OAAA,EACA,SAAA,EACA,MAAA,EACA,aAAA,EACA,OAAA,EACA,iBAAA,EAMA,gBAAA,EACA,SAAA,EACA,MAAA,EACA,QAAA,EACA,cAAA,EACA;AACA,EAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,aAAA,CAAc;AAAA,IACjD,QAAA,EAAU;AAAA,GACX,CAAA;AAED,EAAA,IAAI,MAAA,EAAQ,UAAA,CAAW,CAAA,EAAG,KAAK,GAAG,CAAA,EAAG;AACnC,IAAA,MAAM,kBAAA,CAAmB,QAAQ,MAAM,CAAA;AAAA,EACzC;AAEA,EAAA,MAAM,cAAA,GAAiB;AAAA,IACrB,gBAAA,EAAkB,cAAA;AAAA,IAClB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,mBAAA,EAAqB,iBAAA;AAAA,IACrB,SAAA,EAAW,QAAA;AAAA,IACX,sBAAA,EAAwB,mBAAA;AAAA,IACxB,WAAA;AAAA,IACA,UAAA,EAAY,SAAA;AAAA,IACZ,YAAA,EAAc,WAAA;AAAA,IACd,QAAA,EAAU,OAAA;AAAA,IACV,QAAA;AAAA,IACA,IAAA,EAAM,IAAA;AAAA,IACN,SAAS,cAAA,KAAmB,SAAA;AAAA,IAC5B,2BAAA,EAA6B,wBAAA;AAAA,IAC7B,yBAAA,EAA2B;AAAA,GAC7B;AACA,EAAA,MAAM,mBAAA,GACJ,KAAK,IAAA,CAAK,IAAA,KAAS,iBACf,MAAA,CAAO,IAAA,CAAK,MAAM,WAAA,CAAY;AAAA,IAC5B,GAAG,cAAA;AAAA;AAAA,IAEH,iBAAA,EAAmB,gBAAA;AAAA,IACnB,GAAA,EAAK,KAAA;AAAA;AAAA,IAEL,UAAA,EAAY;AAAA,GACb,CAAA,GACD,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,2BAA2B,cAAc,CAAA;AAEjE,EAAA,IAAI,OAAA;AAEJ,EAAA,IAAI;AACF,IAAA,OAAA,GAAA,CAAW,MAAM,mBAAA,EAAqB,IAAA;AAAA,EACxC,SAAS,CAAA,EAAG;AACV,IAAA,IAAIA,cAAA,CAAQ,CAAC,CAAA,CAAE,OAAA,KAAY,wCAAA,EAA0C;AACnE,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,wFAAwF,IAAA,CAAK,IAAA,CAAK,IAAI,CAAA,YAAA,EAAe,KAAK,IAAI,IAAI,CAAA,CAAA;AAAA,OACpI;AAAA,IACF;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,qBAAA,EAAwB,IAAA,CAAK,IAAA,CAAK,IAAI,CAAA,YAAA,EAAe,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,EAAA,EAChEA,cAAA,CAAQ,CAAC,CAAA,CAAE,OACb,CAAA;AAAA,KACF;AAAA,EACF;AAEA,EAAA,IAAI,MAAA,EAAQ,UAAA,CAAW,CAAA,EAAG,KAAK,GAAG,CAAA,EAAG;AACnC,IAAA,MAAM,GAAG,IAAI,CAAA,GAAI,MAAA,CAAO,MAAM,GAAG,CAAA;AACjC,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,+BAAA,CAAgC;AAAA,MACtD,GAAA,EAAK,KAAA;AAAA,MACL,SAAA,EAAW,IAAA;AAAA,MACX,KAAA;AAAA,MACA,IAAA;AAAA,MACA,UAAA,EAAY;AAAA,KACb,CAAA;AAAA,EAEH,CAAA,MAAA,IAAW,MAAA,IAAU,MAAA,KAAW,KAAA,EAAO;AACrC,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,MACtC,KAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA,EAAU,MAAA;AAAA,MACV,UAAA,EAAY;AAAA,KACb,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,KAAA,MAAW,gBAAgB,aAAA,EAAe;AACxC,MAAA,IAAI;AACF,QAAA,IAAI,UAAU,YAAA,EAAc;AAC1B,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,YACtC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA,EAAUC,0BAAA,CAAgB,YAAA,CAAa,IAAI,CAAA;AAAA,YAC3C,YAAY,YAAA,CAAa;AAAA,WAC1B,CAAA;AAAA,QACH,CAAA,MAAA,IAAW,UAAU,YAAA,EAAc;AACjC,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,+BAAA,CAAgC;AAAA,YACtD,GAAA,EAAK,KAAA;AAAA,YACL,SAAA,EAAWA,0BAAA,CAAgB,YAAA,CAAa,IAAI,CAAA;AAAA,YAC5C,KAAA;AAAA,YACA,IAAA;AAAA,YACA,YAAY,YAAA,CAAa;AAAA,WAC1B,CAAA;AAAA,QACH;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAA,GAAO,wBAAwB,YAAY,CAAA;AACjD,QAAA,MAAA,CAAO,IAAA;AAAA,UACL,CAAA,SAAA,EAAY,aAAa,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,EAAA,EAChDD,cAAA,CAAQ,CAAC,CAAA,CAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,gBAAA,CAAiB;AAAA,QACvC,KAAA;AAAA,QACA,IAAA;AAAA,QACA,OAAO,MAAA,CAAO,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,aAAa;AAAA,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,gBAAA,EAAmB,MAAA,CAAO,IAAA,CAAK,GAAG,CAAC,CAAA,EAAA,EAAKA,cAAA,CAAQ,CAAC,CAAA,CAAE,OAAO,CAAA,CAAE,CAAA;AAAA,IAC1E;AAAA,EACF;AAEA,EAAA,KAAA,MAAW,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAA,CAAQ,aAAA,IAAiB,EAAE,CAAA,EAAG;AAC9D,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,kBAAA,CAAmB;AAAA,MAC3C,KAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAA,EAAM,GAAA;AAAA,MACN;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,MAAM,iBAAA,GAAoB,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,gBAAA,CAAiB;AAAA,MACnE,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAED,IAAA,MAAME,uBAAA,CAAO,KAAA;AACb,IAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,MACvB,kBAAkB,IAAA,CAAK,GAAA;AAAA,MACvBA,wBAAO,eAAA,CAAgB;AAAA,KACzB;AACA,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAO,CAAA,EAAG;AAClD,MAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,KAAK,CAAA;AAC7C,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,QACnC,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,QACnC,qBAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AAEA,MAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,wBAAA,CAAyB;AAAA,QACjD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,WAAA,EAAa,GAAA;AAAA,QACb,eAAA,EAAiB,qBAAA;AAAA,QACjB,MAAA,EAAQ,kBAAkB,IAAA,CAAK;AAAA,OAChC,CAAA;AAAA,IACH;AAAA,EACF;AAEA,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,MAAM,MAAA,CAAO,OAAA;AAAA,MACX,0DAAA;AAAA,MACA;AAAA,QACE,KAAA;AAAA,QACA,IAAA;AAAA,QACA,aAAa,iBAAA,CAAkB,UAAA;AAAA,QAC/B,oBAAoB,iBAAA,CAAkB;AAAA;AACxC,KACF;AAAA,EACF;AAEA,EAAA,IAAI,SAAA,EAAW;AACb,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,QAAA,CAAS,mBAAA,CAAoB;AAAA,MAC7C,UAAA,EAAY,IAAA;AAAA,MACZ,OAAA,EAAS,KAAA;AAAA,MACT,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,cAAA,EAAgB;AAClB,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,6BAAA,CAA8B;AAAA,MACtD,YAAA,EAAc,cAAA;AAAA,MACd,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,OAAA;AACT;AAEA,eAAsB,sBAAA,CACpB,SAAA,EACA,QAAA,EACA,aAAA,EACA,UAAA,EACA,aAAA,EACA,oBAAA,EACA,aAAA,EACA,KAAA,EACA,MAAA,EACA,IAAA,EACA,uBAAA,EACA,2BAAA,EAOA,8BACA,YAAA,EAOA,2BAAA,EACA,2BAAA,EACA,8BAAA,EACA,uBAAA,EACA,MAAA,EACA,MAAA,EACA,gBAAA,EACA,aAAA,EACA,cAAA,EACA,mBAAA,EACA,qBAAA,EACA,qBAAA,EACiC;AACjC,EAAA,MAAM,aAAA,GAAgB;AAAA,IACpB,IAAA,EAAM,aAAA,GACF,aAAA,GACA,MAAA,CAAO,kBAAkB,+BAA+B,CAAA;AAAA,IAC5D,KAAA,EAAO,cAAA,GACH,cAAA,GACA,MAAA,CAAO,kBAAkB,gCAAgC;AAAA,GAC/D;AAEA,EAAA,MAAM,aAAA,GACJ,mBAAA,CAAoB,gBAAA,EAAkB,MAAM,CAAA,IAAK,gBAAA;AAEnD,EAAA,IAAI,YAAA;AAEJ,EAAA,IAAI;AACF,IAAA,YAAA,GAAe,MAAMC,oCAAA,CAAgB;AAAA,MACnC,GAAA,EAAKC,2CAAA,CAAuB,aAAA,EAAe,UAAU,CAAA;AAAA,MACrD,SAAA;AAAA,MACA,aAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,QAAA,EAAU,gBAAA;AAAA,QACV;AAAA,OACF;AAAA,MACA,MAAA;AAAA,MACA,aAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,OAAQ,KAAA,CAAgC,IAAA;AAC9C,IAAA,MAAM,SAAA,GACH,MAAgC,KAAA,EAGhC,IAAA;AACH,IAAA,MAAM,oBACJ,IAAA,KAAS,YAAA,IACT,SAAS,cAAA,IACT,SAAA,KAAc,gBACd,SAAA,KAAc,cAAA;AAChB,IAAA,IAAI,iBAAA,EAAmB;AACrB,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,CAAA,qBAAA,EAAwB,QAAQ,SAAS,CAAA,yHAAA;AAAA,OAG3C;AACA,MAAA,YAAA,GAAe,MAAM,qBAAA,CAAsB;AAAA,QACzC,GAAA,EAAKA,2CAAA,CAAuB,aAAA,EAAe,UAAU,CAAA;AAAA,QACrD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAEA,EAAA,IAAI,oBAAA,EAAsB;AACxB,IAAA,IAAI;AACF,MAAA,MAAMC,oDAAA,CAA0C;AAAA,QAC9C,KAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA,EAAU,IAAA;AAAA,QACV,MAAA;AAAA,QACA,aAAA;AAAA,QACA,2BAAA;AAAA,QACA,4BAAA;AAAA,QACA,YAAA;AAAA,QACA,uBAAA;AAAA,QACA,2BAAA;AAAA,QACA,2BAAA;AAAA,QACA,8BAAA;AAAA,QACA,uBAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,2CAA2C,IAAI,CAAA,GAAA,EAC7CL,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,UAAA,EAAY,YAAA,CAAa,UAAA,EAAW;AAC/C;AAEA,eAAe,mBAAA,CACb,OAAA,EACA,QAAA,GAAmB,EAAA,EACnB,QAAA,EACkD;AAClD,EAAA,MAAM,OAAO,QAAA,IAAY,OAAA;AACzB,EAAA,MAAM,OAAA,GAAoB,MAAMM,gBAAA,CAAW,OAAA,CAAQ,OAAA,EAAS;AAAA,IAC1D,aAAA,EAAe;AAAA,GAChB,CAAA;AACD,EAAA,MAAM,UAAmD,EAAC;AAC1D,EAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,IAAA,MAAM,QAAA,GAAWC,qCAAA;AAAA,MACf,IAAA;AAAA,MACA,WAAW,CAAA,EAAG,QAAQ,IAAI,KAAA,CAAM,IAAI,KAAK,KAAA,CAAM;AAAA,KACjD;AACA,IAAA,MAAM,YAAA,GAAe,WAAW,CAAA,EAAG,QAAQ,IAAI,KAAA,CAAM,IAAI,KAAK,KAAA,CAAM,IAAA;AACpE,IAAA,IAAI,KAAA,CAAM,SAAS,MAAA,EAAQ;AACzB,MAAA;AAAA,IACF;AACA,IAAA,IAAI,KAAA,CAAM,gBAAe,EAAG;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN,GAAI,MAAM,mBAAA,CAAoB,QAAA,EAAU,cAAc,IAAI;AAAA,OAC5D;AAAA,IACF,CAAA,MAAA,IAAW,KAAA,CAAM,MAAA,EAAO,EAAG;AACzB,MAAA,OAAA,CAAQ,IAAA,CAAK;AAAA,QACX,QAAA,EAAU,YAAA;AAAA,QACV,OAAA,EAAS,MAAMD,gBAAA,CAAW,QAAA,CAAS,QAAQ;AAAA,OAC5C,CAAA;AAAA,IACH;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAEA,MAAM,gCAAA,GAAmC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,CAAA;AAUzC,eAAe,sBAAsB,KAAA,EAQD;AAClC,EAAA,MAAM,EAAE,KAAK,KAAA,EAAO,IAAA,EAAM,QAAQ,aAAA,EAAe,aAAA,EAAe,QAAO,GACrE,KAAA;AAEF,EAAA,MAAM,KAAA,GAAQ,MAAM,mBAAA,CAAoB,GAAG,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA;AAAA,IACL,CAAA,UAAA,EAAa,MAAM,MAAM,CAAA,+BAAA,EAAkC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,aAAa,CAAA;AAAA,GAC3F;AAEA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KAEF;AAAA,EACF;AAEA,EAAA,MAAM,aAAA,GAAgB,KAAA,CAAM,MAAA,CAAO,CAAC,GAAA,EAAK,MAAM,GAAA,GAAM,CAAA,CAAE,OAAA,CAAQ,MAAA,EAAQ,CAAC,CAAA;AAExE,EAAA,MAAM,gBAAA,GACJ,KAAK,IAAA,CAAK,aAAA,IAAiB,IAAI,CAAA,CAAE,CAAA,GAAI,MAAM,MAAA,GAAS,IAAA;AACtD,EAAA,MAAM,iBAAA,GAAoB,KAAK,IAAA,GAAO,IAAA;AACtC,EAAA,IAAI,mBAAmB,iBAAA,EAAmB;AACxC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wCAAA,EAAA,CACO,aAAA,GAAgB,IAAA,GAAO,IAAA,EAAM,OAAA,CAAQ,CAAC,CAAC,CAAA,UAAA,EAAA,CACvC,gBAAA,GAAmB,IAAA,GAAO,IAAA,EAAM,OAAA,CAAQ,CAAC,CAAC,CAAA,iGAAA;AAAA,KAEnD;AAAA,EACF;AAEA,EAAA,IAAI,OAAA;AACJ,EAAA,IAAI,YAAA,GAAe,KAAA;AACnB,EAAA,IAAI;AACF,IAAA,MAAM,EAAE,MAAM,GAAA,EAAI,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,IAAI,MAAA,CAAO;AAAA,MACjD,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA,EAAK,SAAS,aAAa,CAAA;AAAA,KAC5B,CAAA;AACD,IAAA,OAAA,GAAU,IAAI,MAAA,CAAO,GAAA;AAAA,EACvB,SAAS,QAAA,EAAmB;AAC1B,IAAA,MAAM,SAAU,QAAA,CAAiC,MAAA;AACjD,IAAA,IAAI,MAAA,KAAW,GAAA,IAAO,MAAA,KAAW,GAAA,EAAK;AACpC,MAAA,MAAM,QAAA;AAAA,IACR;AACA,IAAA,IAAI,WAAW,GAAA,EAAK;AAClB,MAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,EAAE,KAAA,EAAO,IAAA,EAAM,CAAA;AACtE,MAAA,IAAI,QAAA,CAAS,OAAO,CAAA,EAAG;AACrB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,QAAA,EAAW,aAAa,CAAA,eAAA,EAAkB,KAAK,IAAI,IAAI,CAAA,mDAAA,EACD,SAAS,cAAc,CAAA,EAAA;AAAA,SAC/E;AAAA,MACF;AAAA,IACF;AACA,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,8BAA8B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,aAAa,YAC/C,MAAM,CAAA,0BAAA;AAAA,KACrB;AACA,IAAA,MAAM,EAAE,MAAM,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,0BAAA,CAA2B;AAAA,MACxE,KAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAA,EAAM,UAAA;AAAA,MACN,OAAA,EAAS,uBAAA;AAAA,MACT,OAAA,EAAS,EAAA;AAAA,MACT,MAAA,EAAQ;AAAA,KACT,CAAA;AACD,IAAA,OAAA,GAAU,KAAK,MAAA,CAAO,GAAA;AACtB,IAAA,YAAA,GAAe,IAAA;AAAA,EACjB;AAEA,EAAA,MAAM,SAAA,GAAY,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,IACnC,MAAM,IAAA,CAAK,QAAA;AAAA,IACX,QAAA,EAAU,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,QAAQ;AAAA,GAC1C,CAAE,CAAA;AAEF,EAAA,MAAM,WAAA,GAGF;AAAA,IACF;AAAA,GACF;AACA,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,WAAA,CAAY,SAAA,GAAY,CAAC,EAAE,IAAA,EAAM,YAAY,CAAA;AAAA,EAC/C;AAEA,EAAA,MAAM,WAAA,GAAc;AAAA,IAClB,MAAA,EAAQ;AAAA,MACN,uBAAA,EAAyB,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,MACzC,UAAA,EAAY;AAAA,KACd;AAAA,IACA,OAAA,EAAS,EAAE,QAAA,EAAU,aAAA,EAAc;AAAA,IACnC,WAAA;AAAA,IACA,eAAA,EAAiB;AAAA,GACnB;AAEA,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,MAAM,MAAA,CAAO,OAAA,CAAQ,gCAAA,EAAkC;AAAA,MAC9D,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH,SAAS,WAAA,EAAsB;AAC7B,IAAA,MAAM,GAAA,GAAM,MAAA,CAAQ,WAAA,CAAsB,OAAA,IAAW,EAAE,CAAA;AACvD,IAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,iBAAiB,CAAA,EAAG;AACpC,MAAA,MAAM,WAAA;AAAA,IACR;AACA,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,YAAA,EAAe,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,aAAa,CAAA,iDAAA;AAAA,KAC/C;AACA,IAAA,MAAM,EAAE,MAAM,QAAA,EAAS,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,IAAI,MAAA,CAAO;AAAA,MACtD,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA,EAAK,SAAS,aAAa,CAAA;AAAA,KAC5B,CAAA;AACD,IAAA,WAAA,CAAY,eAAA,GAAkB,SAAS,MAAA,CAAO,GAAA;AAC9C,IAAA,MAAA,GAAS,MAAM,MAAA,CAAO,OAAA,CAAQ,gCAAA,EAAkC;AAAA,MAC9D,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH;AAEA,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,oBAAA,CAAqB,MAAA,CAAO,GAAA;AACtD,EAAA,MAAA,CAAO,IAAA;AAAA,IACL,CAAA,OAAA,EAAU,KAAA,CAAM,MAAM,CAAA,UAAA,EAAa,KAAK,IAAI,IAAI,CAAA,CAAA,EAAI,aAAa,CAAA,yBAAA,EAA4B,UAAU,CAAA,CAAA;AAAA,GACzG;AACA,EAAA,OAAO,EAAE,UAAA,EAAW;AACtB;AAEA,SAAS,wBACP,YAAA,EACA;AACA,EAAA,IAAI,cAAc,YAAA,EAAc;AAC9B,IAAA,OAAO,YAAA,CAAa,QAAA;AAAA,EACtB;AACA,EAAA,IAAI,UAAU,YAAA,EAAc;AAC1B,IAAA,OAAO,YAAA,CAAa,IAAA;AAAA,EACtB;AACA,EAAA,OAAO,YAAA,CAAa,IAAA;AACtB;AAEA,eAAe,kBAAA,CAAmB,QAAiB,MAAA,EAAgB;AACjE,EAAA,MAAM,CAAC,GAAA,EAAK,SAAS,CAAA,GAAI,MAAA,CAAO,MAAM,GAAG,CAAA;AACzC,EAAA,IAAI;AAIF,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU;AAAA,MAChC,GAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH,SAAS,CAAA,EAAG;AACV,IAAA,IAAI,CAAA,CAAE,QAAA,CAAS,IAAA,CAAK,OAAA,KAAY,WAAA,EAAa;AAC3C,MAAA,MAAM,OAAA,GAAU,CAAA;AAAA,QAAA,EACZ,GAAG,aAAa,SAAS,CAAA,6BAAA,CAAA;AAC7B,MAAA,MAAM,IAAIE,qBAAc,OAAO,CAAA;AAAA,IACjC;AAAA,EACF;AACF;AAEO,SAAS,mBAAA,CACd,kBACA,MAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,GACH,gBAAA,GACA,MAAA,CAAO,iBAAA,CAAkB,iCAAiC,CAAA;AAChE;;;;"}
1
+ {"version":3,"file":"helpers.cjs.js","sources":["../../src/actions/helpers.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { InputError, NotFoundError, toError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { promises as fsPromises, Dirent } from 'node:fs';\n\nimport {\n getRepoSourceDirectory,\n initRepoAndPush,\n} from '@backstage/plugin-scaffolder-node';\n\nimport Sodium from 'libsodium-wrappers';\nimport {\n enableBranchProtectionOnDefaultRepoBranch,\n entityRefToName,\n} from './gitHelpers';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport async function createGithubRepoWithCollaboratorsAndTopics(\n client: Octokit,\n repo: string,\n owner: string,\n repoVisibility: 'private' | 'internal' | 'public' | undefined,\n description: string | undefined,\n homepage: string | undefined,\n deleteBranchOnMerge: boolean,\n allowMergeCommit: boolean,\n allowSquashMerge: boolean,\n squashMergeCommitTitle: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined,\n squashMergeCommitMessage: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK' | undefined,\n allowRebaseMerge: boolean,\n allowAutoMerge: boolean,\n allowUpdateBranch: boolean,\n access: string | undefined,\n collaborators:\n | (\n | {\n user: string;\n access: string;\n }\n | {\n team: string;\n access: string;\n }\n | {\n /** @deprecated This field is deprecated in favor of team */\n username: string;\n access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';\n }\n )[]\n | undefined,\n hasProjects: boolean | undefined,\n hasWiki: boolean | undefined,\n hasIssues: boolean | undefined,\n topics: string[] | undefined,\n repoVariables: { [key: string]: string } | undefined,\n secrets: { [key: string]: string } | undefined,\n oidcCustomization:\n | {\n useDefault: boolean;\n includeClaimKeys?: string[];\n }\n | undefined,\n customProperties: { [key: string]: string | string[] } | undefined,\n subscribe: boolean | undefined,\n logger: LoggerService,\n autoInit?: boolean | undefined,\n workflowAccess?: 'none' | 'organization' | 'user',\n) {\n const user = await client.rest.users.getByUsername({\n username: owner,\n });\n\n if (access?.startsWith(`${owner}/`)) {\n await validateAccessTeam(client, access);\n }\n\n const baseRepoParams = {\n allow_auto_merge: allowAutoMerge,\n allow_merge_commit: allowMergeCommit,\n allow_rebase_merge: allowRebaseMerge,\n allow_squash_merge: allowSquashMerge,\n allow_update_branch: allowUpdateBranch,\n auto_init: autoInit,\n delete_branch_on_merge: deleteBranchOnMerge,\n description,\n has_issues: hasIssues,\n has_projects: hasProjects,\n has_wiki: hasWiki,\n homepage,\n name: repo,\n private: repoVisibility === 'private',\n squash_merge_commit_message: squashMergeCommitMessage,\n squash_merge_commit_title: squashMergeCommitTitle,\n };\n const repoCreationPromise =\n user.data.type === 'Organization'\n ? client.rest.repos.createInOrg({\n ...baseRepoParams,\n // Custom properties only available on org repos\n custom_properties: customProperties,\n org: owner,\n // @ts-ignore https://github.com/octokit/types.ts/issues/522\n visibility: repoVisibility,\n })\n : client.rest.repos.createForAuthenticatedUser(baseRepoParams);\n\n let newRepo;\n\n try {\n newRepo = (await repoCreationPromise).data;\n } catch (e) {\n if (toError(e).message === 'Resource not accessible by integration') {\n logger.warn(\n `The GitHub app or token provided may not have the required permissions to create the ${user.data.type} repository ${owner}/${repo}.`,\n );\n }\n throw new Error(\n `Failed to create the ${user.data.type} repository ${owner}/${repo}, ${\n toError(e).message\n }`,\n );\n }\n\n if (access?.startsWith(`${owner}/`)) {\n const [, team] = access.split('/');\n await client.rest.teams.addOrUpdateRepoPermissionsInOrg({\n org: owner,\n team_slug: team,\n owner,\n repo,\n permission: 'admin',\n });\n // No need to add access if it's the person who owns the personal account\n } else if (access && access !== owner) {\n await client.rest.repos.addCollaborator({\n owner,\n repo,\n username: access,\n permission: 'admin',\n });\n }\n\n if (collaborators) {\n for (const collaborator of collaborators) {\n try {\n if ('user' in collaborator) {\n await client.rest.repos.addCollaborator({\n owner,\n repo,\n username: entityRefToName(collaborator.user),\n permission: collaborator.access,\n });\n } else if ('team' in collaborator) {\n await client.rest.teams.addOrUpdateRepoPermissionsInOrg({\n org: owner,\n team_slug: entityRefToName(collaborator.team),\n owner,\n repo,\n permission: collaborator.access,\n });\n }\n } catch (e) {\n const name = extractCollaboratorName(collaborator);\n logger.warn(\n `Skipping ${collaborator.access} access for ${name}, ${\n toError(e).message\n }`,\n );\n }\n }\n }\n\n if (topics) {\n try {\n await client.rest.repos.replaceAllTopics({\n owner,\n repo,\n names: topics.map(t => t.toLowerCase()),\n });\n } catch (e) {\n logger.warn(`Skipping topics ${topics.join(' ')}, ${toError(e).message}`);\n }\n }\n\n for (const [key, value] of Object.entries(repoVariables ?? {})) {\n await client.rest.actions.createRepoVariable({\n owner,\n repo,\n name: key,\n value: value,\n });\n }\n\n if (secrets) {\n const publicKeyResponse = await client.rest.actions.getRepoPublicKey({\n owner,\n repo,\n });\n\n await Sodium.ready;\n const binaryKey = Sodium.from_base64(\n publicKeyResponse.data.key,\n Sodium.base64_variants.ORIGINAL,\n );\n for (const [key, value] of Object.entries(secrets)) {\n const binarySecret = Sodium.from_string(value);\n const encryptedBinarySecret = Sodium.crypto_box_seal(\n binarySecret,\n binaryKey,\n );\n const encryptedBase64Secret = Sodium.to_base64(\n encryptedBinarySecret,\n Sodium.base64_variants.ORIGINAL,\n );\n\n await client.rest.actions.createOrUpdateRepoSecret({\n owner,\n repo,\n secret_name: key,\n encrypted_value: encryptedBase64Secret,\n key_id: publicKeyResponse.data.key_id,\n });\n }\n }\n\n if (oidcCustomization) {\n await client.request(\n 'PUT /repos/{owner}/{repo}/actions/oidc/customization/sub',\n {\n owner,\n repo,\n use_default: oidcCustomization.useDefault,\n include_claim_keys: oidcCustomization.includeClaimKeys,\n },\n );\n }\n\n if (subscribe) {\n await client.rest.activity.setRepoSubscription({\n subscribed: true,\n ignored: false,\n owner,\n repo,\n });\n }\n\n if (workflowAccess) {\n await client.rest.actions.setWorkflowAccessToRepository({\n access_level: workflowAccess,\n owner,\n repo,\n });\n }\n\n return newRepo;\n}\n\nexport async function initRepoPushAndProtect(\n remoteUrl: string,\n password: string,\n workspacePath: string,\n sourcePath: string | undefined,\n defaultBranch: string,\n protectDefaultBranch: boolean,\n enforceAdmins: boolean,\n owner: string,\n client: Octokit,\n repo: string,\n requireCodeOwnerReviews: boolean,\n bypassPullRequestAllowances:\n | {\n users?: string[];\n teams?: string[];\n apps?: string[];\n }\n | undefined,\n requiredApprovingReviewCount: number,\n restrictions:\n | {\n users: string[];\n teams: string[];\n apps?: string[];\n }\n | undefined,\n requiredStatusCheckContexts: string[],\n requireBranchesToBeUpToDate: boolean,\n requiredConversationResolution: boolean,\n requireLastPushApproval: boolean,\n config: Config,\n logger: any,\n gitCommitMessage?: string,\n gitAuthorName?: string,\n gitAuthorEmail?: string,\n dismissStaleReviews?: boolean,\n requiredCommitSigning?: boolean,\n requiredLinearHistory?: boolean,\n): Promise<{ commitHash: string }> {\n const gitAuthorInfo = {\n name: gitAuthorName\n ? gitAuthorName\n : config.getOptionalString('scaffolder.defaultAuthor.name'),\n email: gitAuthorEmail\n ? gitAuthorEmail\n : config.getOptionalString('scaffolder.defaultAuthor.email'),\n };\n\n const commitMessage =\n getGitCommitMessage(gitCommitMessage, config) || 'initial commit';\n\n let commitResult: { commitHash: string };\n\n try {\n commitResult = await initRepoAndPush({\n dir: getRepoSourceDirectory(workspacePath, sourcePath),\n remoteUrl,\n defaultBranch,\n auth: {\n username: 'x-access-token',\n password,\n },\n logger,\n commitMessage,\n gitAuthorInfo,\n });\n } catch (error) {\n const code = (error as NodeJS.ErrnoException).code;\n const causeCode = (\n (error as NodeJS.ErrnoException).cause as\n | NodeJS.ErrnoException\n | undefined\n )?.code;\n const isConnectionError =\n code === 'ECONNRESET' ||\n code === 'ECONNREFUSED' ||\n causeCode === 'ECONNRESET' ||\n causeCode === 'ECONNREFUSED';\n if (isConnectionError) {\n logger.warn(\n `Git push failed with ${code ?? causeCode}, retrying via GitHub API. ` +\n 'This can happen when a network proxy blocks the binary payload ' +\n 'in the git smart HTTP protocol.',\n );\n commitResult = await pushFilesViaGitHubApi({\n dir: getRepoSourceDirectory(workspacePath, sourcePath),\n owner,\n repo,\n client,\n defaultBranch,\n commitMessage,\n logger,\n });\n } else {\n throw error;\n }\n }\n\n if (protectDefaultBranch) {\n try {\n await enableBranchProtectionOnDefaultRepoBranch({\n owner,\n client,\n repoName: repo,\n logger,\n defaultBranch,\n bypassPullRequestAllowances,\n requiredApprovingReviewCount,\n restrictions,\n requireCodeOwnerReviews,\n requiredStatusCheckContexts,\n requireBranchesToBeUpToDate,\n requiredConversationResolution,\n requireLastPushApproval,\n enforceAdmins,\n dismissStaleReviews,\n requiredCommitSigning,\n requiredLinearHistory,\n });\n } catch (e) {\n logger.warn(\n `Skipping: default branch protection on '${repo}', ${\n toError(e).message\n }`,\n );\n }\n }\n\n return { commitHash: commitResult.commitHash };\n}\n\nasync function collectFilesFromDir(\n dirPath: string,\n basePath: string = '',\n rootPath?: string,\n): Promise<{ filePath: string; content: Buffer }[]> {\n const root = rootPath ?? dirPath;\n const entries: Dirent[] = await fsPromises.readdir(dirPath, {\n withFileTypes: true,\n });\n const results: { filePath: string; content: Buffer }[] = [];\n for (const entry of entries) {\n const fullPath = resolveSafeChildPath(\n root,\n basePath ? `${basePath}/${entry.name}` : entry.name,\n );\n const relativePath = basePath ? `${basePath}/${entry.name}` : entry.name;\n if (entry.name === '.git') {\n continue;\n }\n if (entry.isSymbolicLink()) {\n continue;\n }\n if (entry.isDirectory()) {\n results.push(\n ...(await collectFilesFromDir(fullPath, relativePath, root)),\n );\n } else if (entry.isFile()) {\n results.push({\n filePath: relativePath,\n content: await fsPromises.readFile(fullPath),\n });\n }\n }\n return results;\n}\n\nconst CREATE_COMMIT_ON_BRANCH_MUTATION = `\n mutation CreateCommitOnBranch($input: CreateCommitOnBranchInput!) {\n createCommitOnBranch(input: $input) {\n commit {\n oid\n }\n }\n }\n`;\n\nasync function pushFilesViaGitHubApi(input: {\n dir: string;\n owner: string;\n repo: string;\n client: Octokit;\n defaultBranch: string;\n commitMessage: string;\n logger: LoggerService;\n}): Promise<{ commitHash: string }> {\n const { dir, owner, repo, client, defaultBranch, commitMessage, logger } =\n input;\n\n const files = await collectFilesFromDir(dir);\n logger.info(\n `Collected ${files.length} files for push via GraphQL to ${owner}/${repo}#${defaultBranch}`,\n );\n\n if (files.length === 0) {\n throw new Error(\n 'GraphQL API fallback found no files to push. ' +\n 'The workspace directory may be empty.',\n );\n }\n\n const totalRawBytes = files.reduce((sum, f) => sum + f.content.length, 0);\n // base64 expands content by ~4/3; add 1 KB per file for JSON overhead\n const estimatedPayload =\n Math.ceil(totalRawBytes * (4 / 3)) + files.length * 1024;\n const MAX_PAYLOAD_BYTES = 30 * 1024 * 1024; // 30 MB after encoding\n if (estimatedPayload > MAX_PAYLOAD_BYTES) {\n throw new Error(\n `GraphQL API fallback payload too large ` +\n `(${(totalRawBytes / 1024 / 1024).toFixed(1)} MB raw, ` +\n `~${(estimatedPayload / 1024 / 1024).toFixed(1)} MB encoded). ` +\n 'Consider reducing template size or resolving the network issue preventing git push.',\n );\n }\n\n let headOid: string;\n let needsCleanup = false;\n try {\n const { data: ref } = await client.rest.git.getRef({\n owner,\n repo,\n ref: `heads/${defaultBranch}`,\n });\n headOid = ref.object.sha;\n } catch (refError: unknown) {\n const status = (refError as { status?: number }).status;\n if (status !== 404 && status !== 409) {\n throw refError;\n }\n if (status === 404) {\n const { data: repoData } = await client.rest.repos.get({ owner, repo });\n if (repoData.size > 0) {\n throw new Error(\n `Branch '${defaultBranch}' not found in ${owner}/${repo}. ` +\n `The repository exists and its default branch is '${repoData.default_branch}'.`,\n );\n }\n }\n logger.info(\n `No existing HEAD found for ${owner}/${repo}#${defaultBranch} ` +\n `(status ${status}), initializing repository`,\n );\n const { data: init } = await client.rest.repos.createOrUpdateFileContents({\n owner,\n repo,\n path: '.gitkeep',\n message: 'initialize repository',\n content: '',\n branch: defaultBranch,\n });\n headOid = init.commit.sha!;\n needsCleanup = true;\n }\n\n const additions = files.map(file => ({\n path: file.filePath,\n contents: file.content.toString('base64'),\n }));\n\n const fileChanges: {\n additions: typeof additions;\n deletions?: { path: string }[];\n } = {\n additions,\n };\n if (needsCleanup) {\n fileChanges.deletions = [{ path: '.gitkeep' }];\n }\n\n const commitInput = {\n branch: {\n repositoryNameWithOwner: `${owner}/${repo}`,\n branchName: defaultBranch,\n },\n message: { headline: commitMessage },\n fileChanges,\n expectedHeadOid: headOid,\n };\n\n let result: { createCommitOnBranch: { commit: { oid: string } } };\n try {\n result = await client.graphql(CREATE_COMMIT_ON_BRANCH_MUTATION, {\n input: commitInput,\n });\n } catch (commitError: unknown) {\n const msg = String((commitError as Error).message ?? '');\n if (!msg.includes('expectedHeadOid')) {\n throw commitError;\n }\n logger.warn(\n `HEAD OID of ${owner}/${repo}#${defaultBranch} changed since read, retrying GraphQL commit once`,\n );\n const { data: freshRef } = await client.rest.git.getRef({\n owner,\n repo,\n ref: `heads/${defaultBranch}`,\n });\n commitInput.expectedHeadOid = freshRef.object.sha;\n result = await client.graphql(CREATE_COMMIT_ON_BRANCH_MUTATION, {\n input: commitInput,\n });\n }\n\n const commitHash = result.createCommitOnBranch.commit.oid;\n logger.info(\n `Pushed ${files.length} files to ${owner}/${repo}#${defaultBranch} via GitHub GraphQL API (${commitHash})`,\n );\n return { commitHash };\n}\n\nfunction extractCollaboratorName(\n collaborator: { user: string } | { team: string } | { username: string },\n) {\n if ('username' in collaborator) {\n return collaborator.username;\n }\n if ('user' in collaborator) {\n return collaborator.user;\n }\n return collaborator.team;\n}\n\nasync function validateAccessTeam(client: Octokit, access: string) {\n const [org, team_slug] = access.split('/');\n try {\n // Below rule disabled because of a 'getByName' check for a different library\n // incorrectly triggers here.\n // eslint-disable-next-line testing-library/no-await-sync-queries\n await client.rest.teams.getByName({\n org,\n team_slug,\n });\n } catch (e) {\n if (e.response.data.message === 'Not Found') {\n const message = `Received 'Not Found' from the API; one of org:\n ${org} or team: ${team_slug} was not found within GitHub.`;\n throw new NotFoundError(message);\n }\n }\n}\n\nexport function getGitCommitMessage(\n gitCommitMessage: string | undefined,\n config: Config,\n): string | undefined {\n return gitCommitMessage\n ? gitCommitMessage\n : config.getOptionalString('scaffolder.defaultCommitMessage');\n}\n\nexport function assertValidTargetPath(\n targetPath: string,\n inputName = 'targetPath',\n) {\n if (targetPath.startsWith('/') || targetPath.split('/').includes('..')) {\n throw new InputError(\n `Invalid ${inputName} '${targetPath}': must be a relative path within the target repository, without '..' segments`,\n );\n }\n}\n"],"names":["toError","entityRefToName","Sodium","initRepoAndPush","getRepoSourceDirectory","enableBranchProtectionOnDefaultRepoBranch","fsPromises","resolveSafeChildPath","NotFoundError","InputError"],"mappings":";;;;;;;;;;;;;AAkCA,eAAsB,0CAAA,CACpB,MAAA,EACA,IAAA,EACA,KAAA,EACA,cAAA,EACA,WAAA,EACA,QAAA,EACA,mBAAA,EACA,gBAAA,EACA,gBAAA,EACA,sBAAA,EACA,wBAAA,EACA,gBAAA,EACA,cAAA,EACA,iBAAA,EACA,MAAA,EACA,aAAA,EAiBA,WAAA,EACA,OAAA,EACA,SAAA,EACA,MAAA,EACA,aAAA,EACA,OAAA,EACA,iBAAA,EAMA,gBAAA,EACA,SAAA,EACA,MAAA,EACA,QAAA,EACA,cAAA,EACA;AACA,EAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,aAAA,CAAc;AAAA,IACjD,QAAA,EAAU;AAAA,GACX,CAAA;AAED,EAAA,IAAI,MAAA,EAAQ,UAAA,CAAW,CAAA,EAAG,KAAK,GAAG,CAAA,EAAG;AACnC,IAAA,MAAM,kBAAA,CAAmB,QAAQ,MAAM,CAAA;AAAA,EACzC;AAEA,EAAA,MAAM,cAAA,GAAiB;AAAA,IACrB,gBAAA,EAAkB,cAAA;AAAA,IAClB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,kBAAA,EAAoB,gBAAA;AAAA,IACpB,mBAAA,EAAqB,iBAAA;AAAA,IACrB,SAAA,EAAW,QAAA;AAAA,IACX,sBAAA,EAAwB,mBAAA;AAAA,IACxB,WAAA;AAAA,IACA,UAAA,EAAY,SAAA;AAAA,IACZ,YAAA,EAAc,WAAA;AAAA,IACd,QAAA,EAAU,OAAA;AAAA,IACV,QAAA;AAAA,IACA,IAAA,EAAM,IAAA;AAAA,IACN,SAAS,cAAA,KAAmB,SAAA;AAAA,IAC5B,2BAAA,EAA6B,wBAAA;AAAA,IAC7B,yBAAA,EAA2B;AAAA,GAC7B;AACA,EAAA,MAAM,mBAAA,GACJ,KAAK,IAAA,CAAK,IAAA,KAAS,iBACf,MAAA,CAAO,IAAA,CAAK,MAAM,WAAA,CAAY;AAAA,IAC5B,GAAG,cAAA;AAAA;AAAA,IAEH,iBAAA,EAAmB,gBAAA;AAAA,IACnB,GAAA,EAAK,KAAA;AAAA;AAAA,IAEL,UAAA,EAAY;AAAA,GACb,CAAA,GACD,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,2BAA2B,cAAc,CAAA;AAEjE,EAAA,IAAI,OAAA;AAEJ,EAAA,IAAI;AACF,IAAA,OAAA,GAAA,CAAW,MAAM,mBAAA,EAAqB,IAAA;AAAA,EACxC,SAAS,CAAA,EAAG;AACV,IAAA,IAAIA,cAAA,CAAQ,CAAC,CAAA,CAAE,OAAA,KAAY,wCAAA,EAA0C;AACnE,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,wFAAwF,IAAA,CAAK,IAAA,CAAK,IAAI,CAAA,YAAA,EAAe,KAAK,IAAI,IAAI,CAAA,CAAA;AAAA,OACpI;AAAA,IACF;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,qBAAA,EAAwB,IAAA,CAAK,IAAA,CAAK,IAAI,CAAA,YAAA,EAAe,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,EAAA,EAChEA,cAAA,CAAQ,CAAC,CAAA,CAAE,OACb,CAAA;AAAA,KACF;AAAA,EACF;AAEA,EAAA,IAAI,MAAA,EAAQ,UAAA,CAAW,CAAA,EAAG,KAAK,GAAG,CAAA,EAAG;AACnC,IAAA,MAAM,GAAG,IAAI,CAAA,GAAI,MAAA,CAAO,MAAM,GAAG,CAAA;AACjC,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,+BAAA,CAAgC;AAAA,MACtD,GAAA,EAAK,KAAA;AAAA,MACL,SAAA,EAAW,IAAA;AAAA,MACX,KAAA;AAAA,MACA,IAAA;AAAA,MACA,UAAA,EAAY;AAAA,KACb,CAAA;AAAA,EAEH,CAAA,MAAA,IAAW,MAAA,IAAU,MAAA,KAAW,KAAA,EAAO;AACrC,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,MACtC,KAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA,EAAU,MAAA;AAAA,MACV,UAAA,EAAY;AAAA,KACb,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,KAAA,MAAW,gBAAgB,aAAA,EAAe;AACxC,MAAA,IAAI;AACF,QAAA,IAAI,UAAU,YAAA,EAAc;AAC1B,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB;AAAA,YACtC,KAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA,EAAUC,0BAAA,CAAgB,YAAA,CAAa,IAAI,CAAA;AAAA,YAC3C,YAAY,YAAA,CAAa;AAAA,WAC1B,CAAA;AAAA,QACH,CAAA,MAAA,IAAW,UAAU,YAAA,EAAc;AACjC,UAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,+BAAA,CAAgC;AAAA,YACtD,GAAA,EAAK,KAAA;AAAA,YACL,SAAA,EAAWA,0BAAA,CAAgB,YAAA,CAAa,IAAI,CAAA;AAAA,YAC5C,KAAA;AAAA,YACA,IAAA;AAAA,YACA,YAAY,YAAA,CAAa;AAAA,WAC1B,CAAA;AAAA,QACH;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAA,GAAO,wBAAwB,YAAY,CAAA;AACjD,QAAA,MAAA,CAAO,IAAA;AAAA,UACL,CAAA,SAAA,EAAY,aAAa,MAAM,CAAA,YAAA,EAAe,IAAI,CAAA,EAAA,EAChDD,cAAA,CAAQ,CAAC,CAAA,CAAE,OACb,CAAA;AAAA,SACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,gBAAA,CAAiB;AAAA,QACvC,KAAA;AAAA,QACA,IAAA;AAAA,QACA,OAAO,MAAA,CAAO,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,aAAa;AAAA,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,IAAA,CAAK,CAAA,gBAAA,EAAmB,MAAA,CAAO,IAAA,CAAK,GAAG,CAAC,CAAA,EAAA,EAAKA,cAAA,CAAQ,CAAC,CAAA,CAAE,OAAO,CAAA,CAAE,CAAA;AAAA,IAC1E;AAAA,EACF;AAEA,EAAA,KAAA,MAAW,CAAC,KAAK,KAAK,CAAA,IAAK,OAAO,OAAA,CAAQ,aAAA,IAAiB,EAAE,CAAA,EAAG;AAC9D,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,kBAAA,CAAmB;AAAA,MAC3C,KAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAA,EAAM,GAAA;AAAA,MACN;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,MAAM,iBAAA,GAAoB,MAAM,MAAA,CAAO,IAAA,CAAK,QAAQ,gBAAA,CAAiB;AAAA,MACnE,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAED,IAAA,MAAME,uBAAA,CAAO,KAAA;AACb,IAAA,MAAM,YAAYA,uBAAA,CAAO,WAAA;AAAA,MACvB,kBAAkB,IAAA,CAAK,GAAA;AAAA,MACvBA,wBAAO,eAAA,CAAgB;AAAA,KACzB;AACA,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAO,CAAA,EAAG;AAClD,MAAA,MAAM,YAAA,GAAeA,uBAAA,CAAO,WAAA,CAAY,KAAK,CAAA;AAC7C,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,eAAA;AAAA,QACnC,YAAA;AAAA,QACA;AAAA,OACF;AACA,MAAA,MAAM,wBAAwBA,uBAAA,CAAO,SAAA;AAAA,QACnC,qBAAA;AAAA,QACAA,wBAAO,eAAA,CAAgB;AAAA,OACzB;AAEA,MAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,wBAAA,CAAyB;AAAA,QACjD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,WAAA,EAAa,GAAA;AAAA,QACb,eAAA,EAAiB,qBAAA;AAAA,QACjB,MAAA,EAAQ,kBAAkB,IAAA,CAAK;AAAA,OAChC,CAAA;AAAA,IACH;AAAA,EACF;AAEA,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,MAAM,MAAA,CAAO,OAAA;AAAA,MACX,0DAAA;AAAA,MACA;AAAA,QACE,KAAA;AAAA,QACA,IAAA;AAAA,QACA,aAAa,iBAAA,CAAkB,UAAA;AAAA,QAC/B,oBAAoB,iBAAA,CAAkB;AAAA;AACxC,KACF;AAAA,EACF;AAEA,EAAA,IAAI,SAAA,EAAW;AACb,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,QAAA,CAAS,mBAAA,CAAoB;AAAA,MAC7C,UAAA,EAAY,IAAA;AAAA,MACZ,OAAA,EAAS,KAAA;AAAA,MACT,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,IAAI,cAAA,EAAgB;AAClB,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,OAAA,CAAQ,6BAAA,CAA8B;AAAA,MACtD,YAAA,EAAc,cAAA;AAAA,MACd,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,OAAA;AACT;AAEA,eAAsB,sBAAA,CACpB,SAAA,EACA,QAAA,EACA,aAAA,EACA,UAAA,EACA,aAAA,EACA,oBAAA,EACA,aAAA,EACA,KAAA,EACA,MAAA,EACA,IAAA,EACA,uBAAA,EACA,2BAAA,EAOA,8BACA,YAAA,EAOA,2BAAA,EACA,2BAAA,EACA,8BAAA,EACA,uBAAA,EACA,MAAA,EACA,MAAA,EACA,gBAAA,EACA,aAAA,EACA,cAAA,EACA,mBAAA,EACA,qBAAA,EACA,qBAAA,EACiC;AACjC,EAAA,MAAM,aAAA,GAAgB;AAAA,IACpB,IAAA,EAAM,aAAA,GACF,aAAA,GACA,MAAA,CAAO,kBAAkB,+BAA+B,CAAA;AAAA,IAC5D,KAAA,EAAO,cAAA,GACH,cAAA,GACA,MAAA,CAAO,kBAAkB,gCAAgC;AAAA,GAC/D;AAEA,EAAA,MAAM,aAAA,GACJ,mBAAA,CAAoB,gBAAA,EAAkB,MAAM,CAAA,IAAK,gBAAA;AAEnD,EAAA,IAAI,YAAA;AAEJ,EAAA,IAAI;AACF,IAAA,YAAA,GAAe,MAAMC,oCAAA,CAAgB;AAAA,MACnC,GAAA,EAAKC,2CAAA,CAAuB,aAAA,EAAe,UAAU,CAAA;AAAA,MACrD,SAAA;AAAA,MACA,aAAA;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,QAAA,EAAU,gBAAA;AAAA,QACV;AAAA,OACF;AAAA,MACA,MAAA;AAAA,MACA,aAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,OAAQ,KAAA,CAAgC,IAAA;AAC9C,IAAA,MAAM,SAAA,GACH,MAAgC,KAAA,EAGhC,IAAA;AACH,IAAA,MAAM,oBACJ,IAAA,KAAS,YAAA,IACT,SAAS,cAAA,IACT,SAAA,KAAc,gBACd,SAAA,KAAc,cAAA;AAChB,IAAA,IAAI,iBAAA,EAAmB;AACrB,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,CAAA,qBAAA,EAAwB,QAAQ,SAAS,CAAA,yHAAA;AAAA,OAG3C;AACA,MAAA,YAAA,GAAe,MAAM,qBAAA,CAAsB;AAAA,QACzC,GAAA,EAAKA,2CAAA,CAAuB,aAAA,EAAe,UAAU,CAAA;AAAA,QACrD,KAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,aAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAEA,EAAA,IAAI,oBAAA,EAAsB;AACxB,IAAA,IAAI;AACF,MAAA,MAAMC,oDAAA,CAA0C;AAAA,QAC9C,KAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA,EAAU,IAAA;AAAA,QACV,MAAA;AAAA,QACA,aAAA;AAAA,QACA,2BAAA;AAAA,QACA,4BAAA;AAAA,QACA,YAAA;AAAA,QACA,uBAAA;AAAA,QACA,2BAAA;AAAA,QACA,2BAAA;AAAA,QACA,8BAAA;AAAA,QACA,uBAAA;AAAA,QACA,aAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,2CAA2C,IAAI,CAAA,GAAA,EAC7CL,cAAA,CAAQ,CAAC,EAAE,OACb,CAAA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,UAAA,EAAY,YAAA,CAAa,UAAA,EAAW;AAC/C;AAEA,eAAe,mBAAA,CACb,OAAA,EACA,QAAA,GAAmB,EAAA,EACnB,QAAA,EACkD;AAClD,EAAA,MAAM,OAAO,QAAA,IAAY,OAAA;AACzB,EAAA,MAAM,OAAA,GAAoB,MAAMM,gBAAA,CAAW,OAAA,CAAQ,OAAA,EAAS;AAAA,IAC1D,aAAA,EAAe;AAAA,GAChB,CAAA;AACD,EAAA,MAAM,UAAmD,EAAC;AAC1D,EAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,IAAA,MAAM,QAAA,GAAWC,qCAAA;AAAA,MACf,IAAA;AAAA,MACA,WAAW,CAAA,EAAG,QAAQ,IAAI,KAAA,CAAM,IAAI,KAAK,KAAA,CAAM;AAAA,KACjD;AACA,IAAA,MAAM,YAAA,GAAe,WAAW,CAAA,EAAG,QAAQ,IAAI,KAAA,CAAM,IAAI,KAAK,KAAA,CAAM,IAAA;AACpE,IAAA,IAAI,KAAA,CAAM,SAAS,MAAA,EAAQ;AACzB,MAAA;AAAA,IACF;AACA,IAAA,IAAI,KAAA,CAAM,gBAAe,EAAG;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN,GAAI,MAAM,mBAAA,CAAoB,QAAA,EAAU,cAAc,IAAI;AAAA,OAC5D;AAAA,IACF,CAAA,MAAA,IAAW,KAAA,CAAM,MAAA,EAAO,EAAG;AACzB,MAAA,OAAA,CAAQ,IAAA,CAAK;AAAA,QACX,QAAA,EAAU,YAAA;AAAA,QACV,OAAA,EAAS,MAAMD,gBAAA,CAAW,QAAA,CAAS,QAAQ;AAAA,OAC5C,CAAA;AAAA,IACH;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAEA,MAAM,gCAAA,GAAmC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,CAAA;AAUzC,eAAe,sBAAsB,KAAA,EAQD;AAClC,EAAA,MAAM,EAAE,KAAK,KAAA,EAAO,IAAA,EAAM,QAAQ,aAAA,EAAe,aAAA,EAAe,QAAO,GACrE,KAAA;AAEF,EAAA,MAAM,KAAA,GAAQ,MAAM,mBAAA,CAAoB,GAAG,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA;AAAA,IACL,CAAA,UAAA,EAAa,MAAM,MAAM,CAAA,+BAAA,EAAkC,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,aAAa,CAAA;AAAA,GAC3F;AAEA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR;AAAA,KAEF;AAAA,EACF;AAEA,EAAA,MAAM,aAAA,GAAgB,KAAA,CAAM,MAAA,CAAO,CAAC,GAAA,EAAK,MAAM,GAAA,GAAM,CAAA,CAAE,OAAA,CAAQ,MAAA,EAAQ,CAAC,CAAA;AAExE,EAAA,MAAM,gBAAA,GACJ,KAAK,IAAA,CAAK,aAAA,IAAiB,IAAI,CAAA,CAAE,CAAA,GAAI,MAAM,MAAA,GAAS,IAAA;AACtD,EAAA,MAAM,iBAAA,GAAoB,KAAK,IAAA,GAAO,IAAA;AACtC,EAAA,IAAI,mBAAmB,iBAAA,EAAmB;AACxC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wCAAA,EAAA,CACO,aAAA,GAAgB,IAAA,GAAO,IAAA,EAAM,OAAA,CAAQ,CAAC,CAAC,CAAA,UAAA,EAAA,CACvC,gBAAA,GAAmB,IAAA,GAAO,IAAA,EAAM,OAAA,CAAQ,CAAC,CAAC,CAAA,iGAAA;AAAA,KAEnD;AAAA,EACF;AAEA,EAAA,IAAI,OAAA;AACJ,EAAA,IAAI,YAAA,GAAe,KAAA;AACnB,EAAA,IAAI;AACF,IAAA,MAAM,EAAE,MAAM,GAAA,EAAI,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,IAAI,MAAA,CAAO;AAAA,MACjD,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA,EAAK,SAAS,aAAa,CAAA;AAAA,KAC5B,CAAA;AACD,IAAA,OAAA,GAAU,IAAI,MAAA,CAAO,GAAA;AAAA,EACvB,SAAS,QAAA,EAAmB;AAC1B,IAAA,MAAM,SAAU,QAAA,CAAiC,MAAA;AACjD,IAAA,IAAI,MAAA,KAAW,GAAA,IAAO,MAAA,KAAW,GAAA,EAAK;AACpC,MAAA,MAAM,QAAA;AAAA,IACR;AACA,IAAA,IAAI,WAAW,GAAA,EAAK;AAClB,MAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,EAAE,KAAA,EAAO,IAAA,EAAM,CAAA;AACtE,MAAA,IAAI,QAAA,CAAS,OAAO,CAAA,EAAG;AACrB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,QAAA,EAAW,aAAa,CAAA,eAAA,EAAkB,KAAK,IAAI,IAAI,CAAA,mDAAA,EACD,SAAS,cAAc,CAAA,EAAA;AAAA,SAC/E;AAAA,MACF;AAAA,IACF;AACA,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,8BAA8B,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,aAAa,YAC/C,MAAM,CAAA,0BAAA;AAAA,KACrB;AACA,IAAA,MAAM,EAAE,MAAM,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,MAAM,0BAAA,CAA2B;AAAA,MACxE,KAAA;AAAA,MACA,IAAA;AAAA,MACA,IAAA,EAAM,UAAA;AAAA,MACN,OAAA,EAAS,uBAAA;AAAA,MACT,OAAA,EAAS,EAAA;AAAA,MACT,MAAA,EAAQ;AAAA,KACT,CAAA;AACD,IAAA,OAAA,GAAU,KAAK,MAAA,CAAO,GAAA;AACtB,IAAA,YAAA,GAAe,IAAA;AAAA,EACjB;AAEA,EAAA,MAAM,SAAA,GAAY,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,IACnC,MAAM,IAAA,CAAK,QAAA;AAAA,IACX,QAAA,EAAU,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,QAAQ;AAAA,GAC1C,CAAE,CAAA;AAEF,EAAA,MAAM,WAAA,GAGF;AAAA,IACF;AAAA,GACF;AACA,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,WAAA,CAAY,SAAA,GAAY,CAAC,EAAE,IAAA,EAAM,YAAY,CAAA;AAAA,EAC/C;AAEA,EAAA,MAAM,WAAA,GAAc;AAAA,IAClB,MAAA,EAAQ;AAAA,MACN,uBAAA,EAAyB,CAAA,EAAG,KAAK,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,MACzC,UAAA,EAAY;AAAA,KACd;AAAA,IACA,OAAA,EAAS,EAAE,QAAA,EAAU,aAAA,EAAc;AAAA,IACnC,WAAA;AAAA,IACA,eAAA,EAAiB;AAAA,GACnB;AAEA,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,MAAM,MAAA,CAAO,OAAA,CAAQ,gCAAA,EAAkC;AAAA,MAC9D,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH,SAAS,WAAA,EAAsB;AAC7B,IAAA,MAAM,GAAA,GAAM,MAAA,CAAQ,WAAA,CAAsB,OAAA,IAAW,EAAE,CAAA;AACvD,IAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,iBAAiB,CAAA,EAAG;AACpC,MAAA,MAAM,WAAA;AAAA,IACR;AACA,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,YAAA,EAAe,KAAK,CAAA,CAAA,EAAI,IAAI,IAAI,aAAa,CAAA,iDAAA;AAAA,KAC/C;AACA,IAAA,MAAM,EAAE,MAAM,QAAA,EAAS,GAAI,MAAM,MAAA,CAAO,IAAA,CAAK,IAAI,MAAA,CAAO;AAAA,MACtD,KAAA;AAAA,MACA,IAAA;AAAA,MACA,GAAA,EAAK,SAAS,aAAa,CAAA;AAAA,KAC5B,CAAA;AACD,IAAA,WAAA,CAAY,eAAA,GAAkB,SAAS,MAAA,CAAO,GAAA;AAC9C,IAAA,MAAA,GAAS,MAAM,MAAA,CAAO,OAAA,CAAQ,gCAAA,EAAkC;AAAA,MAC9D,KAAA,EAAO;AAAA,KACR,CAAA;AAAA,EACH;AAEA,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,oBAAA,CAAqB,MAAA,CAAO,GAAA;AACtD,EAAA,MAAA,CAAO,IAAA;AAAA,IACL,CAAA,OAAA,EAAU,KAAA,CAAM,MAAM,CAAA,UAAA,EAAa,KAAK,IAAI,IAAI,CAAA,CAAA,EAAI,aAAa,CAAA,yBAAA,EAA4B,UAAU,CAAA,CAAA;AAAA,GACzG;AACA,EAAA,OAAO,EAAE,UAAA,EAAW;AACtB;AAEA,SAAS,wBACP,YAAA,EACA;AACA,EAAA,IAAI,cAAc,YAAA,EAAc;AAC9B,IAAA,OAAO,YAAA,CAAa,QAAA;AAAA,EACtB;AACA,EAAA,IAAI,UAAU,YAAA,EAAc;AAC1B,IAAA,OAAO,YAAA,CAAa,IAAA;AAAA,EACtB;AACA,EAAA,OAAO,YAAA,CAAa,IAAA;AACtB;AAEA,eAAe,kBAAA,CAAmB,QAAiB,MAAA,EAAgB;AACjE,EAAA,MAAM,CAAC,GAAA,EAAK,SAAS,CAAA,GAAI,MAAA,CAAO,MAAM,GAAG,CAAA;AACzC,EAAA,IAAI;AAIF,IAAA,MAAM,MAAA,CAAO,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU;AAAA,MAChC,GAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH,SAAS,CAAA,EAAG;AACV,IAAA,IAAI,CAAA,CAAE,QAAA,CAAS,IAAA,CAAK,OAAA,KAAY,WAAA,EAAa;AAC3C,MAAA,MAAM,OAAA,GAAU,CAAA;AAAA,QAAA,EACZ,GAAG,aAAa,SAAS,CAAA,6BAAA,CAAA;AAC7B,MAAA,MAAM,IAAIE,qBAAc,OAAO,CAAA;AAAA,IACjC;AAAA,EACF;AACF;AAEO,SAAS,mBAAA,CACd,kBACA,MAAA,EACoB;AACpB,EAAA,OAAO,gBAAA,GACH,gBAAA,GACA,MAAA,CAAO,iBAAA,CAAkB,iCAAiC,CAAA;AAChE;AAEO,SAAS,qBAAA,CACd,UAAA,EACA,SAAA,GAAY,YAAA,EACZ;AACA,EAAA,IAAI,UAAA,CAAW,UAAA,CAAW,GAAG,CAAA,IAAK,UAAA,CAAW,MAAM,GAAG,CAAA,CAAE,QAAA,CAAS,IAAI,CAAA,EAAG;AACtE,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,CAAA,QAAA,EAAW,SAAS,CAAA,EAAA,EAAK,UAAU,CAAA,8EAAA;AAAA,KACrC;AAAA,EACF;AACF;;;;;"}
package/dist/index.cjs.js CHANGED
@@ -15,6 +15,7 @@ var github = require('./actions/github.cjs.js');
15
15
  var githubAutolinks = require('./actions/githubAutolinks.cjs.js');
16
16
  var githubPagesEnable = require('./actions/githubPagesEnable.cjs.js');
17
17
  var githubBranchProtection = require('./actions/githubBranchProtection.cjs.js');
18
+ var githubRulesets = require('./actions/githubRulesets.cjs.js');
18
19
  var module$1 = require('./module.cjs.js');
19
20
  var util = require('./util.cjs.js');
20
21
 
@@ -33,6 +34,7 @@ exports.createPublishGithubAction = github.createPublishGithubAction;
33
34
  exports.createGithubAutolinksAction = githubAutolinks.createGithubAutolinksAction;
34
35
  exports.createGithubPagesEnableAction = githubPagesEnable.createGithubPagesEnableAction;
35
36
  exports.createGithubBranchProtectionAction = githubBranchProtection.createGithubBranchProtectionAction;
37
+ exports.createGithubRepoRulesetsCreateAction = githubRulesets.createGithubRepoRulesetsCreateAction;
36
38
  exports.default = module$1.githubModule;
37
39
  exports.getOctokitClient = util.getOctokitClient;
38
40
  exports.getOctokitOptions = util.getOctokitOptions;
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/dist/index.d.ts CHANGED
@@ -457,6 +457,40 @@ declare function createGithubBranchProtectionAction(options: {
457
457
  [x: string]: any;
458
458
  }, "v2">;
459
459
 
460
+ /**
461
+ * Creates a `github:repo:rulesets:create` Scaffolder action that creates a ruleset in a GitHub repository.
462
+ *
463
+ * @public
464
+ */
465
+ declare function createGithubRepoRulesetsCreateAction(options: {
466
+ integrations: ScmIntegrationRegistry;
467
+ githubCredentialsProvider?: GithubCredentialsProvider;
468
+ requireScmUserCredentials?: boolean;
469
+ }): _backstage_plugin_scaffolder_node.TemplateAction<{
470
+ repoUrl: string;
471
+ name: string;
472
+ target: "tag" | "branch";
473
+ enforcement: "active" | "disabled" | "evaluate";
474
+ conditions?: {
475
+ ref_name?: {
476
+ include?: string[] | undefined;
477
+ exclude?: string[] | undefined;
478
+ } | undefined;
479
+ } | undefined;
480
+ rules?: {
481
+ type: string;
482
+ parameters?: Record<string, any> | undefined;
483
+ }[] | undefined;
484
+ bypassActors?: {
485
+ actor_type: string;
486
+ bypass_mode?: "always" | "pull_request" | "exempt" | undefined;
487
+ actor_id?: number | null | undefined;
488
+ }[] | undefined;
489
+ token?: string | undefined;
490
+ }, {
491
+ id: number;
492
+ }, "v2">;
493
+
460
494
  /**
461
495
  * @public
462
496
  * The GitHub Module for the Scaffolder Backend
@@ -519,5 +553,5 @@ declare function getOctokitOptions(options: {
519
553
  repoUrl: string;
520
554
  }): Promise<OctokitOptions>;
521
555
 
522
- export { createGithubActionsDispatchAction, createGithubAutolinksAction, createGithubBranchProtectionAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesCreateAction, createGithubIssuesLabelAction, createGithubPagesEnableAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishGithubAction, createPublishGithubPullRequestAction, githubModule as default, getOctokitClient, getOctokitOptions };
556
+ export { createGithubActionsDispatchAction, createGithubAutolinksAction, createGithubBranchProtectionAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesCreateAction, createGithubIssuesLabelAction, createGithubPagesEnableAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubRepoRulesetsCreateAction, createGithubWebhookAction, createPublishGithubAction, createPublishGithubPullRequestAction, githubModule as default, getOctokitClient, getOctokitOptions };
523
557
  export type { CreateGithubPullRequestActionOptions, RetryOptions };
@@ -15,6 +15,7 @@ var github = require('./actions/github.cjs.js');
15
15
  var githubAutolinks = require('./actions/githubAutolinks.cjs.js');
16
16
  var githubPagesEnable = require('./actions/githubPagesEnable.cjs.js');
17
17
  var githubBranchProtection = require('./actions/githubBranchProtection.cjs.js');
18
+ var githubRulesets = require('./actions/githubRulesets.cjs.js');
18
19
  var integration = require('@backstage/integration');
19
20
  var autocomplete = require('./autocomplete/autocomplete.cjs.js');
20
21
  var pluginCatalogNode = require('@backstage/plugin-catalog-node');
@@ -100,6 +101,11 @@ const githubModule = backendPluginApi.createBackendModule({
100
101
  githubBranchProtection.createGithubBranchProtectionAction({
101
102
  integrations,
102
103
  requireScmUserCredentials
104
+ }),
105
+ githubRulesets.createGithubRepoRulesetsCreateAction({
106
+ integrations,
107
+ githubCredentialsProvider,
108
+ requireScmUserCredentials
103
109
  })
104
110
  );
105
111
  autocomplete$1.addAutocompleteProvider({
@@ -1 +1 @@
1
- {"version":3,"file":"module.cjs.js","sources":["../src/module.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 */\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderAutocompleteExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n createGithubActionsDispatchAction,\n createGithubAutolinksAction,\n createGithubDeployKeyAction,\n createGithubEnvironmentAction,\n createGithubIssuesLabelAction,\n createGithubIssuesCreateAction,\n createGithubRepoCreateAction,\n createGithubRepoPushAction,\n createGithubWebhookAction,\n createPublishGithubAction,\n createPublishGithubPullRequestAction,\n createGithubPagesEnableAction,\n createGithubBranchProtectionAction,\n} from './actions';\nimport {\n DefaultGithubCredentialsProvider,\n ScmIntegrations,\n} from '@backstage/integration';\nimport { createHandleAutocompleteRequest } from './autocomplete/autocomplete';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\n\n/**\n * @public\n * The GitHub Module for the Scaffolder Backend\n */\nexport const githubModule = createBackendModule({\n pluginId: 'scaffolder',\n moduleId: 'github',\n register({ registerInit }) {\n registerInit({\n deps: {\n scaffolder: scaffolderActionsExtensionPoint,\n config: coreServices.rootConfig,\n catalog: catalogServiceRef,\n autocomplete: scaffolderAutocompleteExtensionPoint,\n },\n async init({ scaffolder, config, autocomplete, catalog }) {\n const integrations = ScmIntegrations.fromConfig(config);\n const requireScmUserCredentials =\n config.getOptionalBoolean('scaffolder.requireScmUserCredentials') ??\n false;\n const githubCredentialsProvider =\n DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n\n scaffolder.addActions(\n createGithubActionsDispatchAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubAutolinksAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubDeployKeyAction({\n integrations,\n requireScmUserCredentials,\n }),\n createGithubEnvironmentAction({\n integrations,\n catalog,\n requireScmUserCredentials,\n }),\n createGithubIssuesLabelAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubIssuesCreateAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubRepoCreateAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubRepoPushAction({\n integrations,\n config,\n requireScmUserCredentials,\n }),\n createGithubWebhookAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createPublishGithubAction({\n integrations,\n config,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createPublishGithubPullRequestAction({\n integrations,\n githubCredentialsProvider,\n config,\n requireScmUserCredentials,\n }),\n createGithubPagesEnableAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubBranchProtectionAction({\n integrations,\n requireScmUserCredentials,\n }),\n );\n\n autocomplete.addAutocompleteProvider({\n id: 'github',\n handler: createHandleAutocompleteRequest({ integrations }),\n });\n },\n });\n },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","catalogServiceRef","scaffolderAutocompleteExtensionPoint","autocomplete","ScmIntegrations","DefaultGithubCredentialsProvider","createGithubActionsDispatchAction","createGithubAutolinksAction","createGithubDeployKeyAction","createGithubEnvironmentAction","createGithubIssuesLabelAction","createGithubIssuesCreateAction","createGithubRepoCreateAction","createGithubRepoPushAction","createGithubWebhookAction","createPublishGithubAction","createPublishGithubPullRequestAction","createGithubPagesEnableAction","createGithubBranchProtectionAction","createHandleAutocompleteRequest"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA+CO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,OAAA,EAASC,mCAAA;AAAA,QACT,YAAA,EAAcC;AAAA,OAChB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,YAAY,MAAA,gBAAQC,cAAA,EAAc,SAAQ,EAAG;AACxD,QAAA,MAAM,YAAA,GAAeC,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,QAAA,MAAM,yBAAA,GACJ,MAAA,CAAO,kBAAA,CAAmB,sCAAsC,CAAA,IAChE,KAAA;AACF,QAAA,MAAM,yBAAA,GACJC,4CAAA,CAAiC,gBAAA,CAAiB,YAAY,CAAA;AAEhE,QAAA,UAAA,CAAW,UAAA;AAAA,UACTC,uDAAA,CAAkC;AAAA,YAChC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,2CAAA,CAA4B;AAAA,YAC1B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,2CAAA,CAA4B;AAAA,YAC1B,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,OAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,iDAAA,CAA+B;AAAA,YAC7B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,6CAAA,CAA6B;AAAA,YAC3B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yCAAA,CAA2B;AAAA,YACzB,YAAA;AAAA,YACA,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,uCAAA,CAA0B;AAAA,YACxB,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,gCAAA,CAA0B;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,sDAAA,CAAqC;AAAA,YACnC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yDAAA,CAAmC;AAAA,YACjC,YAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAEA,QAAAf,cAAA,CAAa,uBAAA,CAAwB;AAAA,UACnC,EAAA,EAAI,QAAA;AAAA,UACJ,OAAA,EAASgB,4CAAA,CAAgC,EAAE,YAAA,EAAc;AAAA,SAC1D,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;"}
1
+ {"version":3,"file":"module.cjs.js","sources":["../src/module.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 */\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderAutocompleteExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n createGithubActionsDispatchAction,\n createGithubAutolinksAction,\n createGithubDeployKeyAction,\n createGithubEnvironmentAction,\n createGithubIssuesLabelAction,\n createGithubIssuesCreateAction,\n createGithubRepoCreateAction,\n createGithubRepoPushAction,\n createGithubWebhookAction,\n createPublishGithubAction,\n createPublishGithubPullRequestAction,\n createGithubPagesEnableAction,\n createGithubBranchProtectionAction,\n createGithubRepoRulesetsCreateAction,\n} from './actions';\nimport {\n DefaultGithubCredentialsProvider,\n ScmIntegrations,\n} from '@backstage/integration';\nimport { createHandleAutocompleteRequest } from './autocomplete/autocomplete';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\n\n/**\n * @public\n * The GitHub Module for the Scaffolder Backend\n */\nexport const githubModule = createBackendModule({\n pluginId: 'scaffolder',\n moduleId: 'github',\n register({ registerInit }) {\n registerInit({\n deps: {\n scaffolder: scaffolderActionsExtensionPoint,\n config: coreServices.rootConfig,\n catalog: catalogServiceRef,\n autocomplete: scaffolderAutocompleteExtensionPoint,\n },\n async init({ scaffolder, config, autocomplete, catalog }) {\n const integrations = ScmIntegrations.fromConfig(config);\n const requireScmUserCredentials =\n config.getOptionalBoolean('scaffolder.requireScmUserCredentials') ??\n false;\n const githubCredentialsProvider =\n DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n\n scaffolder.addActions(\n createGithubActionsDispatchAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubAutolinksAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubDeployKeyAction({\n integrations,\n requireScmUserCredentials,\n }),\n createGithubEnvironmentAction({\n integrations,\n catalog,\n requireScmUserCredentials,\n }),\n createGithubIssuesLabelAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubIssuesCreateAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubRepoCreateAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubRepoPushAction({\n integrations,\n config,\n requireScmUserCredentials,\n }),\n createGithubWebhookAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createPublishGithubAction({\n integrations,\n config,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createPublishGithubPullRequestAction({\n integrations,\n githubCredentialsProvider,\n config,\n requireScmUserCredentials,\n }),\n createGithubPagesEnableAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n createGithubBranchProtectionAction({\n integrations,\n requireScmUserCredentials,\n }),\n createGithubRepoRulesetsCreateAction({\n integrations,\n githubCredentialsProvider,\n requireScmUserCredentials,\n }),\n );\n\n autocomplete.addAutocompleteProvider({\n id: 'github',\n handler: createHandleAutocompleteRequest({ integrations }),\n });\n },\n });\n },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","catalogServiceRef","scaffolderAutocompleteExtensionPoint","autocomplete","ScmIntegrations","DefaultGithubCredentialsProvider","createGithubActionsDispatchAction","createGithubAutolinksAction","createGithubDeployKeyAction","createGithubEnvironmentAction","createGithubIssuesLabelAction","createGithubIssuesCreateAction","createGithubRepoCreateAction","createGithubRepoPushAction","createGithubWebhookAction","createPublishGithubAction","createPublishGithubPullRequestAction","createGithubPagesEnableAction","createGithubBranchProtectionAction","createGithubRepoRulesetsCreateAction","createHandleAutocompleteRequest"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAgDO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,OAAA,EAASC,mCAAA;AAAA,QACT,YAAA,EAAcC;AAAA,OAChB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,YAAY,MAAA,gBAAQC,cAAA,EAAc,SAAQ,EAAG;AACxD,QAAA,MAAM,YAAA,GAAeC,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,QAAA,MAAM,yBAAA,GACJ,MAAA,CAAO,kBAAA,CAAmB,sCAAsC,CAAA,IAChE,KAAA;AACF,QAAA,MAAM,yBAAA,GACJC,4CAAA,CAAiC,gBAAA,CAAiB,YAAY,CAAA;AAEhE,QAAA,UAAA,CAAW,UAAA;AAAA,UACTC,uDAAA,CAAkC;AAAA,YAChC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,2CAAA,CAA4B;AAAA,YAC1B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,2CAAA,CAA4B;AAAA,YAC1B,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,OAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,iDAAA,CAA+B;AAAA,YAC7B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,6CAAA,CAA6B;AAAA,YAC3B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yCAAA,CAA2B;AAAA,YACzB,YAAA;AAAA,YACA,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,uCAAA,CAA0B;AAAA,YACxB,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,gCAAA,CAA0B;AAAA,YACxB,YAAA;AAAA,YACA,MAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,sDAAA,CAAqC;AAAA,YACnC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA,MAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,+CAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yDAAA,CAAmC;AAAA,YACjC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,mDAAA,CAAqC;AAAA,YACnC,YAAA;AAAA,YACA,yBAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAEA,QAAAhB,cAAA,CAAa,uBAAA,CAAwB;AAAA,UACnC,EAAA,EAAI,QAAA;AAAA,UACJ,OAAA,EAASiB,4CAAA,CAAgC,EAAE,YAAA,EAAc;AAAA,SAC1D,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-backend-module-github",
3
- "version": "0.10.2-next.0",
3
+ "version": "0.10.2",
4
4
  "description": "The github module for @backstage/plugin-scaffolder-backend",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -50,14 +50,14 @@
50
50
  "test": "backstage-cli package test"
51
51
  },
52
52
  "dependencies": {
53
- "@backstage/backend-plugin-api": "1.11.1-next.0",
54
- "@backstage/catalog-model": "1.10.2",
55
- "@backstage/config": "1.3.10",
56
- "@backstage/errors": "1.3.2",
57
- "@backstage/integration": "2.1.3",
58
- "@backstage/plugin-catalog-node": "2.2.7-next.0",
59
- "@backstage/plugin-scaffolder-node": "0.13.9-next.0",
60
- "@backstage/types": "1.2.2",
53
+ "@backstage/backend-plugin-api": "^1.12.0",
54
+ "@backstage/catalog-model": "^1.10.3",
55
+ "@backstage/config": "^1.3.11",
56
+ "@backstage/errors": "^1.4.0",
57
+ "@backstage/integration": "^2.2.0",
58
+ "@backstage/plugin-catalog-node": "^3.0.0",
59
+ "@backstage/plugin-scaffolder-node": "^1.0.0",
60
+ "@backstage/types": "^1.2.2",
61
61
  "@octokit/core": "^5.0.0",
62
62
  "@octokit/plugin-retry": "^6.0.0",
63
63
  "@octokit/webhooks": "^10.9.2",
@@ -68,9 +68,9 @@
68
68
  "zod": "^3.25.76 || ^4.0.0"
69
69
  },
70
70
  "devDependencies": {
71
- "@backstage/backend-test-utils": "1.11.9-next.0",
72
- "@backstage/cli": "0.36.8-next.0",
73
- "@backstage/plugin-scaffolder-node-test-utils": "0.3.17-next.0",
71
+ "@backstage/backend-test-utils": "^1.12.0",
72
+ "@backstage/cli": "^0.36.8",
73
+ "@backstage/plugin-scaffolder-node-test-utils": "^0.3.17",
74
74
  "@types/libsodium-wrappers": "^0.8.0",
75
75
  "fs-extra": "^11.2.0",
76
76
  "jsonschema": "^1.2.6"