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

package/dist/actions/github.cjs.js

@@ -0,0 +1,187 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var octokit = require('octokit');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var helpers = require('./helpers.cjs.js');
+var inputProperties = require('./inputProperties.cjs.js');
+var outputProperties = require('./outputProperties.cjs.js');
+var github_examples = require('./github.examples.cjs.js');
+
+function createPublishGithubAction(options) {
+  const { integrations, config, githubCredentialsProvider } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "publish:github",
+    description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
+    examples: github_examples.examples,
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl"],
+        properties: {
+          repoUrl: inputProperties.repoUrl,
+          description: inputProperties.description,
+          homepage: inputProperties.homepage,
+          access: inputProperties.access,
+          bypassPullRequestAllowances: inputProperties.bypassPullRequestAllowances,
+          requiredApprovingReviewCount: inputProperties.requiredApprovingReviewCount,
+          restrictions: inputProperties.restrictions,
+          requireCodeOwnerReviews: inputProperties.requireCodeOwnerReviews,
+          dismissStaleReviews: inputProperties.dismissStaleReviews,
+          requiredStatusCheckContexts: inputProperties.requiredStatusCheckContexts,
+          requireBranchesToBeUpToDate: inputProperties.requireBranchesToBeUpToDate,
+          requiredConversationResolution: inputProperties.requiredConversationResolution,
+          requireLastPushApproval: inputProperties.requireLastPushApproval,
+          repoVisibility: inputProperties.repoVisibility,
+          defaultBranch: inputProperties.defaultBranch,
+          protectDefaultBranch: inputProperties.protectDefaultBranch,
+          protectEnforceAdmins: inputProperties.protectEnforceAdmins,
+          deleteBranchOnMerge: inputProperties.deleteBranchOnMerge,
+          gitCommitMessage: inputProperties.gitCommitMessage,
+          gitAuthorName: inputProperties.gitAuthorName,
+          gitAuthorEmail: inputProperties.gitAuthorEmail,
+          allowMergeCommit: inputProperties.allowMergeCommit,
+          allowSquashMerge: inputProperties.allowSquashMerge,
+          squashMergeCommitTitle: inputProperties.squashMergeCommitTitle,
+          squashMergeCommitMessage: inputProperties.squashMergeCommitMessage,
+          allowRebaseMerge: inputProperties.allowRebaseMerge,
+          allowAutoMerge: inputProperties.allowAutoMerge,
+          sourcePath: inputProperties.sourcePath,
+          collaborators: inputProperties.collaborators,
+          hasProjects: inputProperties.hasProjects,
+          hasWiki: inputProperties.hasWiki,
+          hasIssues: inputProperties.hasIssues,
+          token: inputProperties.token,
+          topics: inputProperties.topics,
+          repoVariables: inputProperties.repoVariables,
+          secrets: inputProperties.secrets,
+          oidcCustomization: inputProperties.oidcCustomization,
+          requiredCommitSigning: inputProperties.requiredCommitSigning,
+          customProperties: inputProperties.customProperties
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          remoteUrl: outputProperties.remoteUrl,
+          repoContentsUrl: outputProperties.repoContentsUrl,
+          commitHash: outputProperties.commitHash
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        description,
+        homepage,
+        access,
+        requireCodeOwnerReviews = false,
+        dismissStaleReviews = false,
+        bypassPullRequestAllowances,
+        requiredApprovingReviewCount = 1,
+        restrictions,
+        requiredStatusCheckContexts = [],
+        requireBranchesToBeUpToDate = true,
+        requiredConversationResolution = false,
+        requireLastPushApproval = false,
+        repoVisibility = "private",
+        defaultBranch = "master",
+        protectDefaultBranch = true,
+        protectEnforceAdmins = true,
+        deleteBranchOnMerge = false,
+        gitCommitMessage,
+        gitAuthorName,
+        gitAuthorEmail,
+        allowMergeCommit = true,
+        allowSquashMerge = true,
+        squashMergeCommitTitle = "COMMIT_OR_PR_TITLE",
+        squashMergeCommitMessage = "COMMIT_MESSAGES",
+        allowRebaseMerge = true,
+        allowAutoMerge = false,
+        collaborators,
+        hasProjects = void 0,
+        hasWiki = void 0,
+        hasIssues = void 0,
+        topics,
+        repoVariables,
+        secrets,
+        oidcCustomization,
+        token: providedToken,
+        customProperties,
+        requiredCommitSigning = false
+      } = ctx.input;
+      const octokitOptions = await helpers.getOctokitOptions({
+        integrations,
+        credentialsProvider: githubCredentialsProvider,
+        token: providedToken,
+        repoUrl
+      });
+      const client = new octokit.Octokit(octokitOptions);
+      const { owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
+      if (!owner) {
+        throw new errors.InputError("Invalid repository owner provided in repoUrl");
+      }
+      const newRepo = await helpers.createGithubRepoWithCollaboratorsAndTopics(
+        client,
+        repo,
+        owner,
+        repoVisibility,
+        description,
+        homepage,
+        deleteBranchOnMerge,
+        allowMergeCommit,
+        allowSquashMerge,
+        squashMergeCommitTitle,
+        squashMergeCommitMessage,
+        allowRebaseMerge,
+        allowAutoMerge,
+        access,
+        collaborators,
+        hasProjects,
+        hasWiki,
+        hasIssues,
+        topics,
+        repoVariables,
+        secrets,
+        oidcCustomization,
+        customProperties,
+        ctx.logger
+      );
+      const remoteUrl = newRepo.clone_url;
+      const repoContentsUrl = `${newRepo.html_url}/blob/${defaultBranch}`;
+      const commitResult = await helpers.initRepoPushAndProtect(
+        remoteUrl,
+        octokitOptions.auth,
+        ctx.workspacePath,
+        ctx.input.sourcePath,
+        defaultBranch,
+        protectDefaultBranch,
+        protectEnforceAdmins,
+        owner,
+        client,
+        repo,
+        requireCodeOwnerReviews,
+        bypassPullRequestAllowances,
+        requiredApprovingReviewCount,
+        restrictions,
+        requiredStatusCheckContexts,
+        requireBranchesToBeUpToDate,
+        requiredConversationResolution,
+        requireLastPushApproval,
+        config,
+        ctx.logger,
+        gitCommitMessage,
+        gitAuthorName,
+        gitAuthorEmail,
+        dismissStaleReviews,
+        requiredCommitSigning
+      );
+      ctx.output("commitHash", commitResult?.commitHash);
+      ctx.output("remoteUrl", remoteUrl);
+      ctx.output("repoContentsUrl", repoContentsUrl);
+    }
+  });
+}
+
+exports.createPublishGithubAction = createPublishGithubAction;
+//# sourceMappingURL=github.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"github.cjs.js","sources":["../../src/actions/github.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Octokit } from 'octokit';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n  createGithubRepoWithCollaboratorsAndTopics,\n  getOctokitOptions,\n  initRepoPushAndProtect,\n} from './helpers';\nimport * as inputProps from './inputProperties';\nimport * as outputProps from './outputProperties';\nimport { examples } from './github.examples';\n\n/**\n * Creates a new action that initializes a git repository of the content in the workspace\n * and publishes it to GitHub.\n *\n * @public\n */\nexport function createPublishGithubAction(options: {\n  integrations: ScmIntegrationRegistry;\n  config: Config;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, config, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    description?: string;\n    homepage?: string;\n    access?: string;\n    defaultBranch?: string;\n    protectDefaultBranch?: boolean;\n    protectEnforceAdmins?: boolean;\n    deleteBranchOnMerge?: boolean;\n    gitCommitMessage?: string;\n    gitAuthorName?: string;\n    gitAuthorEmail?: string;\n    allowRebaseMerge?: boolean;\n    allowSquashMerge?: boolean;\n    squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';\n    squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';\n    allowMergeCommit?: boolean;\n    allowAutoMerge?: boolean;\n    sourcePath?: string;\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    requireCodeOwnerReviews?: boolean;\n    dismissStaleReviews?: boolean;\n    requiredStatusCheckContexts?: string[];\n    requireBranchesToBeUpToDate?: boolean;\n    requiredConversationResolution?: boolean;\n    requireLastPushApproval?: boolean;\n    repoVisibility?: 'private' | 'internal' | 'public';\n    collaborators?: Array<\n      | {\n          user: string;\n          access: string;\n        }\n      | {\n          team: string;\n          access: string;\n        }\n      | {\n          /** @deprecated This field is deprecated in favor of team */\n          username: string;\n          access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';\n        }\n    >;\n    hasProjects?: boolean | undefined;\n    hasWiki?: boolean | undefined;\n    hasIssues?: boolean | undefined;\n    token?: string;\n    topics?: string[];\n    repoVariables?: { [key: string]: string };\n    secrets?: { [key: string]: string };\n    oidcCustomization?: {\n      useDefault: boolean;\n      includeClaimKeys?: string[];\n    };\n    requiredCommitSigning?: boolean;\n    customProperties?: { [key: string]: string };\n  }>({\n    id: 'publish:github',\n    description:\n      'Initializes a git repository of contents in workspace and publishes it to GitHub.',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl'],\n        properties: {\n          repoUrl: inputProps.repoUrl,\n          description: inputProps.description,\n          homepage: inputProps.homepage,\n          access: inputProps.access,\n          bypassPullRequestAllowances: inputProps.bypassPullRequestAllowances,\n          requiredApprovingReviewCount: inputProps.requiredApprovingReviewCount,\n          restrictions: inputProps.restrictions,\n          requireCodeOwnerReviews: inputProps.requireCodeOwnerReviews,\n          dismissStaleReviews: inputProps.dismissStaleReviews,\n          requiredStatusCheckContexts: inputProps.requiredStatusCheckContexts,\n          requireBranchesToBeUpToDate: inputProps.requireBranchesToBeUpToDate,\n          requiredConversationResolution:\n            inputProps.requiredConversationResolution,\n          requireLastPushApproval: inputProps.requireLastPushApproval,\n          repoVisibility: inputProps.repoVisibility,\n          defaultBranch: inputProps.defaultBranch,\n          protectDefaultBranch: inputProps.protectDefaultBranch,\n          protectEnforceAdmins: inputProps.protectEnforceAdmins,\n          deleteBranchOnMerge: inputProps.deleteBranchOnMerge,\n          gitCommitMessage: inputProps.gitCommitMessage,\n          gitAuthorName: inputProps.gitAuthorName,\n          gitAuthorEmail: inputProps.gitAuthorEmail,\n          allowMergeCommit: inputProps.allowMergeCommit,\n          allowSquashMerge: inputProps.allowSquashMerge,\n          squashMergeCommitTitle: inputProps.squashMergeCommitTitle,\n          squashMergeCommitMessage: inputProps.squashMergeCommitMessage,\n          allowRebaseMerge: inputProps.allowRebaseMerge,\n          allowAutoMerge: inputProps.allowAutoMerge,\n          sourcePath: inputProps.sourcePath,\n          collaborators: inputProps.collaborators,\n          hasProjects: inputProps.hasProjects,\n          hasWiki: inputProps.hasWiki,\n          hasIssues: inputProps.hasIssues,\n          token: inputProps.token,\n          topics: inputProps.topics,\n          repoVariables: inputProps.repoVariables,\n          secrets: inputProps.secrets,\n          oidcCustomization: inputProps.oidcCustomization,\n          requiredCommitSigning: inputProps.requiredCommitSigning,\n          customProperties: inputProps.customProperties,\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          remoteUrl: outputProps.remoteUrl,\n          repoContentsUrl: outputProps.repoContentsUrl,\n          commitHash: outputProps.commitHash,\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        description,\n        homepage,\n        access,\n        requireCodeOwnerReviews = false,\n        dismissStaleReviews = false,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount = 1,\n        restrictions,\n        requiredStatusCheckContexts = [],\n        requireBranchesToBeUpToDate = true,\n        requiredConversationResolution = false,\n        requireLastPushApproval = false,\n        repoVisibility = 'private',\n        defaultBranch = 'master',\n        protectDefaultBranch = true,\n        protectEnforceAdmins = true,\n        deleteBranchOnMerge = false,\n        gitCommitMessage,\n        gitAuthorName,\n        gitAuthorEmail,\n        allowMergeCommit = true,\n        allowSquashMerge = true,\n        squashMergeCommitTitle = 'COMMIT_OR_PR_TITLE',\n        squashMergeCommitMessage = 'COMMIT_MESSAGES',\n        allowRebaseMerge = true,\n        allowAutoMerge = false,\n        collaborators,\n        hasProjects = undefined,\n        hasWiki = undefined,\n        hasIssues = undefined,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        token: providedToken,\n        customProperties,\n        requiredCommitSigning = false,\n      } = ctx.input;\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        token: providedToken,\n        repoUrl: repoUrl,\n      });\n      const client = new Octokit(octokitOptions);\n\n      const { owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const newRepo = await createGithubRepoWithCollaboratorsAndTopics(\n        client,\n        repo,\n        owner,\n        repoVisibility,\n        description,\n        homepage,\n        deleteBranchOnMerge,\n        allowMergeCommit,\n        allowSquashMerge,\n        squashMergeCommitTitle,\n        squashMergeCommitMessage,\n        allowRebaseMerge,\n        allowAutoMerge,\n        access,\n        collaborators,\n        hasProjects,\n        hasWiki,\n        hasIssues,\n        topics,\n        repoVariables,\n        secrets,\n        oidcCustomization,\n        customProperties,\n        ctx.logger,\n      );\n\n      const remoteUrl = newRepo.clone_url;\n      const repoContentsUrl = `${newRepo.html_url}/blob/${defaultBranch}`;\n\n      const commitResult = await initRepoPushAndProtect(\n        remoteUrl,\n        octokitOptions.auth,\n        ctx.workspacePath,\n        ctx.input.sourcePath,\n        defaultBranch,\n        protectDefaultBranch,\n        protectEnforceAdmins,\n        owner,\n        client,\n        repo,\n        requireCodeOwnerReviews,\n        bypassPullRequestAllowances,\n        requiredApprovingReviewCount,\n        restrictions,\n        requiredStatusCheckContexts,\n        requireBranchesToBeUpToDate,\n        requiredConversationResolution,\n        requireLastPushApproval,\n        config,\n        ctx.logger,\n        gitCommitMessage,\n        gitAuthorName,\n        gitAuthorEmail,\n        dismissStaleReviews,\n        requiredCommitSigning,\n      );\n\n      ctx.output('commitHash', commitResult?.commitHash);\n      ctx.output('remoteUrl', remoteUrl);\n      ctx.output('repoContentsUrl', repoContentsUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","inputProps.repoUrl","inputProps.description","inputProps.homepage","inputProps.access","inputProps.bypassPullRequestAllowances","inputProps.requiredApprovingReviewCount","inputProps.restrictions","inputProps.requireCodeOwnerReviews","inputProps.dismissStaleReviews","inputProps.requiredStatusCheckContexts","inputProps.requireBranchesToBeUpToDate","inputProps.requiredConversationResolution","inputProps.requireLastPushApproval","inputProps.repoVisibility","inputProps.defaultBranch","inputProps.protectDefaultBranch","inputProps.protectEnforceAdmins","inputProps.deleteBranchOnMerge","inputProps.gitCommitMessage","inputProps.gitAuthorName","inputProps.gitAuthorEmail","inputProps.allowMergeCommit","inputProps.allowSquashMerge","inputProps.squashMergeCommitTitle","inputProps.squashMergeCommitMessage","inputProps.allowRebaseMerge","inputProps.allowAutoMerge","inputProps.sourcePath","inputProps.collaborators","inputProps.hasProjects","inputProps.hasWiki","inputProps.hasIssues","inputProps.token","inputProps.topics","inputProps.repoVariables","inputProps.secrets","inputProps.oidcCustomization","inputProps.requiredCommitSigning","inputProps.customProperties","outputProps.remoteUrl","outputProps.repoContentsUrl","outputProps.commitHash","getOctokitOptions","Octokit","parseRepoUrl","InputError","createGithubRepoWithCollaboratorsAndTopics","initRepoPushAndProtect"],"mappings":";;;;;;;;;;AA0CO,SAAS,0BAA0B,OAIvC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,MAAQ,EAAA,yBAAA,EAA8B,GAAA,OAAA,CAAA;AAE5D,EAAA,OAAOA,yCAqEJ,CAAA;AAAA,IACD,EAAI,EAAA,gBAAA;AAAA,IACJ,WACE,EAAA,mFAAA;AAAA,cACFC,wBAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAS,CAAA;AAAA,QACpB,UAAY,EAAA;AAAA,UACV,SAASC,uBAAW;AAAA,UACpB,aAAaC,2BAAW;AAAA,UACxB,UAAUC,wBAAW;AAAA,UACrB,QAAQC,sBAAW;AAAA,UACnB,6BAA6BC,2CAAW;AAAA,UACxC,8BAA8BC,4CAAW;AAAA,UACzC,cAAcC,4BAAW;AAAA,UACzB,yBAAyBC,uCAAW;AAAA,UACpC,qBAAqBC,mCAAW;AAAA,UAChC,6BAA6BC,2CAAW;AAAA,UACxC,6BAA6BC,2CAAW;AAAA,UACxC,gCACEC,8CAAW;AAAA,UACb,yBAAyBC,uCAAW;AAAA,UACpC,gBAAgBC,8BAAW;AAAA,UAC3B,eAAeC,6BAAW;AAAA,UAC1B,sBAAsBC,oCAAW;AAAA,UACjC,sBAAsBC,oCAAW;AAAA,UACjC,qBAAqBC,mCAAW;AAAA,UAChC,kBAAkBC,gCAAW;AAAA,UAC7B,eAAeC,6BAAW;AAAA,UAC1B,gBAAgBC,8BAAW;AAAA,UAC3B,kBAAkBC,gCAAW;AAAA,UAC7B,kBAAkBC,gCAAW;AAAA,UAC7B,wBAAwBC,sCAAW;AAAA,UACnC,0BAA0BC,wCAAW;AAAA,UACrC,kBAAkBC,gCAAW;AAAA,UAC7B,gBAAgBC,8BAAW;AAAA,UAC3B,YAAYC,0BAAW;AAAA,UACvB,eAAeC,6BAAW;AAAA,UAC1B,aAAaC,2BAAW;AAAA,UACxB,SAASC,uBAAW;AAAA,UACpB,WAAWC,yBAAW;AAAA,UACtB,OAAOC,qBAAW;AAAA,UAClB,QAAQC,sBAAW;AAAA,UACnB,eAAeC,6BAAW;AAAA,UAC1B,SAASC,uBAAW;AAAA,UACpB,mBAAmBC,iCAAW;AAAA,UAC9B,uBAAuBC,qCAAW;AAAA,UAClC,kBAAkBC,gCAAW;AAAA,SAC/B;AAAA,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,WAAWC,0BAAY;AAAA,UACvB,iBAAiBC,gCAAY;AAAA,UAC7B,YAAYC,2BAAY;AAAA,SAC1B;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,QACA,uBAA0B,GAAA,KAAA;AAAA,QAC1B,mBAAsB,GAAA,KAAA;AAAA,QACtB,2BAAA;AAAA,QACA,4BAA+B,GAAA,CAAA;AAAA,QAC/B,YAAA;AAAA,QACA,8BAA8B,EAAC;AAAA,QAC/B,2BAA8B,GAAA,IAAA;AAAA,QAC9B,8BAAiC,GAAA,KAAA;AAAA,QACjC,uBAA0B,GAAA,KAAA;AAAA,QAC1B,cAAiB,GAAA,SAAA;AAAA,QACjB,aAAgB,GAAA,QAAA;AAAA,QAChB,oBAAuB,GAAA,IAAA;AAAA,QACvB,oBAAuB,GAAA,IAAA;AAAA,QACvB,mBAAsB,GAAA,KAAA;AAAA,QACtB,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,gBAAmB,GAAA,IAAA;AAAA,QACnB,gBAAmB,GAAA,IAAA;AAAA,QACnB,sBAAyB,GAAA,oBAAA;AAAA,QACzB,wBAA2B,GAAA,iBAAA;AAAA,QAC3B,gBAAmB,GAAA,IAAA;AAAA,QACnB,cAAiB,GAAA,KAAA;AAAA,QACjB,aAAA;AAAA,QACA,WAAc,GAAA,KAAA,CAAA;AAAA,QACd,OAAU,GAAA,KAAA,CAAA;AAAA,QACV,SAAY,GAAA,KAAA,CAAA;AAAA,QACZ,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,QACP,gBAAA;AAAA,QACA,qBAAwB,GAAA,KAAA;AAAA,UACtB,GAAI,CAAA,KAAA,CAAA;AAER,MAAM,MAAA,cAAA,GAAiB,MAAMC,yBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,KAAO,EAAA,aAAA;AAAA,QACP,OAAA;AAAA,OACD,CAAA,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAA,CAAQ,cAAc,CAAA,CAAA;AAEzC,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AAE1D,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA,CAAA;AAAA,OACrE;AAEA,MAAA,MAAM,UAAU,MAAMC,kDAAA;AAAA,QACpB,MAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAA;AAAA,QACA,cAAA;AAAA,QACA,WAAA;AAAA,QACA,QAAA;AAAA,QACA,mBAAA;AAAA,QACA,gBAAA;AAAA,QACA,gBAAA;AAAA,QACA,sBAAA;AAAA,QACA,wBAAA;AAAA,QACA,gBAAA;AAAA,QACA,cAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,WAAA;AAAA,QACA,OAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,aAAA;AAAA,QACA,OAAA;AAAA,QACA,iBAAA;AAAA,QACA,gBAAA;AAAA,QACA,GAAI,CAAA,MAAA;AAAA,OACN,CAAA;AAEA,MAAA,MAAM,YAAY,OAAQ,CAAA,SAAA,CAAA;AAC1B,MAAA,MAAM,eAAkB,GAAA,CAAA,EAAG,OAAQ,CAAA,QAAQ,SAAS,aAAa,CAAA,CAAA,CAAA;AAEjE,MAAA,MAAM,eAAe,MAAMC,8BAAA;AAAA,QACzB,SAAA;AAAA,QACA,cAAe,CAAA,IAAA;AAAA,QACf,GAAI,CAAA,aAAA;AAAA,QACJ,IAAI,KAAM,CAAA,UAAA;AAAA,QACV,aAAA;AAAA,QACA,oBAAA;AAAA,QACA,oBAAA;AAAA,QACA,KAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,uBAAA;AAAA,QACA,2BAAA;AAAA,QACA,4BAAA;AAAA,QACA,YAAA;AAAA,QACA,2BAAA;AAAA,QACA,2BAAA;AAAA,QACA,8BAAA;AAAA,QACA,uBAAA;AAAA,QACA,MAAA;AAAA,QACA,GAAI,CAAA,MAAA;AAAA,QACJ,gBAAA;AAAA,QACA,aAAA;AAAA,QACA,cAAA;AAAA,QACA,mBAAA;AAAA,QACA,qBAAA;AAAA,OACF,CAAA;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,YAAc,EAAA,YAAA,EAAc,UAAU,CAAA,CAAA;AACjD,MAAI,GAAA,CAAA,MAAA,CAAO,aAAa,SAAS,CAAA,CAAA;AACjC,MAAI,GAAA,CAAA,MAAA,CAAO,mBAAmB,eAAe,CAAA,CAAA;AAAA,KAC/C;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

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

@@ -0,0 +1,60 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Initializes a git repository with the content in the workspace, and publishes it to GitHub with the default configuration.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a GitHub repository with a description.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            description: "Initialize a git repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a GitHub repository with public repo visibility, if not set defaults to private",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            repoVisibility: "public"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=github.examples.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"github.examples.cjs.js","sources":["../../src/actions/github.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 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:\n      'Initializes a git repository with the content in the workspace, and publishes it to GitHub with the default configuration.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'publish',\n          action: 'publish:github',\n          name: 'Publish to GitHub',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Initializes a GitHub repository with a description.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'publish',\n          action: 'publish:github',\n          name: 'Publish to GitHub',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n            description: 'Initialize a git repository',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Initializes a GitHub repository with public repo visibility, if not set defaults to private',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'publish',\n          action: 'publish:github',\n          name: 'Publish to GitHub',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n            repoVisibility: 'public',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WACE,EAAA,4HAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,SAAA;AAAA,UACJ,MAAQ,EAAA,gBAAA;AAAA,UACR,IAAM,EAAA,mBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,WACX;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,qDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,SAAA;AAAA,UACJ,MAAQ,EAAA,gBAAA;AAAA,UACR,IAAM,EAAA,mBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,WAAa,EAAA,6BAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,6FAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,SAAA;AAAA,UACJ,MAAQ,EAAA,gBAAA;AAAA,UACR,IAAM,EAAA,mBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,cAAgB,EAAA,QAAA;AAAA,WAClB;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/actions/githubActionsDispatch.cjs.js

@@ -0,0 +1,84 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var octokit = require('octokit');
+var helpers = require('./helpers.cjs.js');
+var githubActionsDispatch_examples = require('./githubActionsDispatch.examples.cjs.js');
+
+function createGithubActionsDispatchAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "github:actions:dispatch",
+    description: "Dispatches a GitHub Action workflow for a given branch or tag",
+    examples: githubActionsDispatch_examples.examples,
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl", "workflowId", "branchOrTagName"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,
+            type: "string"
+          },
+          workflowId: {
+            title: "Workflow ID",
+            description: "The GitHub Action Workflow filename",
+            type: "string"
+          },
+          branchOrTagName: {
+            title: "Branch or Tag name",
+            description: "The git branch or tag name used to dispatch the workflow",
+            type: "string"
+          },
+          workflowInputs: {
+            title: "Workflow Inputs",
+            description: "Inputs keys and values to send to GitHub Action configured on the workflow file. The maximum number of properties is 10. ",
+            type: "object"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The GITHUB_TOKEN to use for authorization to GitHub"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        workflowId,
+        branchOrTagName,
+        workflowInputs,
+        token: providedToken
+      } = ctx.input;
+      ctx.logger.info(
+        `Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`
+      );
+      const { owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
+      if (!owner) {
+        throw new errors.InputError("Invalid repository owner provided in repoUrl");
+      }
+      const client = new octokit.Octokit(
+        await helpers.getOctokitOptions({
+          integrations,
+          repoUrl,
+          credentialsProvider: githubCredentialsProvider,
+          token: providedToken
+        })
+      );
+      await client.rest.actions.createWorkflowDispatch({
+        owner,
+        repo,
+        workflow_id: workflowId,
+        ref: branchOrTagName,
+        inputs: workflowInputs
+      });
+      ctx.logger.info(`Workflow ${workflowId} dispatched successfully`);
+    }
+  });
+}
+
+exports.createGithubActionsDispatchAction = createGithubActionsDispatchAction;
+//# sourceMappingURL=githubActionsDispatch.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"githubActionsDispatch.cjs.js","sources":["../../src/actions/githubActionsDispatch.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from './helpers';\nimport { examples } from './githubActionsDispatch.examples';\n\n/**\n * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.\n * @public\n */\nexport function createGithubActionsDispatchAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    workflowId: string;\n    branchOrTagName: string;\n    workflowInputs?: { [key: string]: string };\n    token?: string;\n  }>({\n    id: 'github:actions:dispatch',\n    description:\n      'Dispatches a GitHub Action workflow for a given branch or tag',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'workflowId', 'branchOrTagName'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,\n            type: 'string',\n          },\n          workflowId: {\n            title: 'Workflow ID',\n            description: 'The GitHub Action Workflow filename',\n            type: 'string',\n          },\n          branchOrTagName: {\n            title: 'Branch or Tag name',\n            description:\n              'The git branch or tag name used to dispatch the workflow',\n            type: 'string',\n          },\n          workflowInputs: {\n            title: 'Workflow Inputs',\n            description:\n              'Inputs keys and values to send to GitHub Action configured on the workflow file. The maximum number of properties is 10. ',\n            type: 'object',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The GITHUB_TOKEN to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        workflowId,\n        branchOrTagName,\n        workflowInputs,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(\n        `Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`,\n      );\n\n      const { owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          repoUrl,\n          credentialsProvider: githubCredentialsProvider,\n          token: providedToken,\n        }),\n      );\n\n      await client.rest.actions.createWorkflowDispatch({\n        owner,\n        repo,\n        workflow_id: workflowId,\n        ref: branchOrTagName,\n        inputs: workflowInputs,\n      });\n\n      ctx.logger.info(`Workflow ${workflowId} dispatched successfully`);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions"],"mappings":";;;;;;;;AAiCO,SAAS,kCAAkC,OAG/C,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA,CAAA;AAEpD,EAAA,OAAOA,yCAMJ,CAAA;AAAA,IACD,EAAI,EAAA,yBAAA;AAAA,IACJ,WACE,EAAA,+DAAA;AAAA,cACFC,uCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAU,EAAA,CAAC,SAAW,EAAA,YAAA,EAAc,iBAAiB,CAAA;AAAA,QACrD,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,CAAA,gJAAA,CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,qCAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,eAAiB,EAAA;AAAA,YACf,KAAO,EAAA,oBAAA;AAAA,YACP,WACE,EAAA,0DAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,KAAO,EAAA,iBAAA;AAAA,YACP,WACE,EAAA,2HAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,qDAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,eAAA;AAAA,QACA,cAAA;AAAA,QACA,KAAO,EAAA,aAAA;AAAA,UACL,GAAI,CAAA,KAAA,CAAA;AAER,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,QACT,CAAwB,qBAAA,EAAA,UAAU,CAAa,UAAA,EAAA,OAAO,OAAO,eAAe,CAAA,CAAA;AAAA,OAC9E,CAAA;AAEA,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AAE1D,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA,CAAA;AAAA,OACrE;AAEA,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,yBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,OAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,KAAO,EAAA,aAAA;AAAA,SACR,CAAA;AAAA,OACH,CAAA;AAEA,MAAM,MAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,sBAAuB,CAAA;AAAA,QAC/C,KAAA;AAAA,QACA,IAAA;AAAA,QACA,WAAa,EAAA,UAAA;AAAA,QACb,GAAK,EAAA,eAAA;AAAA,QACL,MAAQ,EAAA,cAAA;AAAA,OACT,CAAA,CAAA;AAED,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAY,SAAA,EAAA,UAAU,CAA0B,wBAAA,CAAA,CAAA,CAAA;AAAA,KAClE;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

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

@@ -0,0 +1,66 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "GitHub Action Workflow Without Inputs.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch Github Action Workflow",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "main"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "GitHub Action Workflow With Inputs",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch Github Action Workflow with inputs",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "main",
+            workflowInputs: {
+              input1: "value1",
+              input2: "value2"
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "GitHub Action Workflow With Custom Token",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch GitHub Action Workflow (custom token)",
+          input: {
+            repoUrl: "github.com?repo=reponame&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "release-1.0",
+            token: "${{ secrets.MY_CUSTOM_TOKEN }}"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=githubActionsDispatch.examples.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"githubActionsDispatch.examples.cjs.js","sources":["../../src/actions/githubActionsDispatch.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 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: 'GitHub Action Workflow Without Inputs.',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'github:actions:dispatch',\n          name: 'Dispatch Github Action Workflow',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n            workflowId: 'WORKFLOW_ID',\n            branchOrTagName: 'main',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'GitHub Action Workflow With Inputs',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'github:actions:dispatch',\n          name: 'Dispatch Github Action Workflow with inputs',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n            workflowId: 'WORKFLOW_ID',\n            branchOrTagName: 'main',\n            workflowInputs: {\n              input1: 'value1',\n              input2: 'value2',\n            },\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'GitHub Action Workflow With Custom Token',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'github:actions:dispatch',\n          name: 'Dispatch GitHub Action Workflow (custom token)',\n          input: {\n            repoUrl: 'github.com?repo=reponame&owner=owner',\n            workflowId: 'WORKFLOW_ID',\n            branchOrTagName: 'release-1.0',\n            token: '${{ secrets.MY_CUSTOM_TOKEN }}',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,wCAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,yBAAA;AAAA,UACR,IAAM,EAAA,iCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,UAAY,EAAA,aAAA;AAAA,YACZ,eAAiB,EAAA,MAAA;AAAA,WACnB;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,oCAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,yBAAA;AAAA,UACR,IAAM,EAAA,6CAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,UAAY,EAAA,aAAA;AAAA,YACZ,eAAiB,EAAA,MAAA;AAAA,YACjB,cAAgB,EAAA;AAAA,cACd,MAAQ,EAAA,QAAA;AAAA,cACR,MAAQ,EAAA,QAAA;AAAA,aACV;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,0CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,yBAAA;AAAA,UACR,IAAM,EAAA,gDAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,sCAAA;AAAA,YACT,UAAY,EAAA,aAAA;AAAA,YACZ,eAAiB,EAAA,aAAA;AAAA,YACjB,KAAO,EAAA,gCAAA;AAAA,WACT;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/actions/githubAutolinks.cjs.js

@@ -0,0 +1,76 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var octokit = require('octokit');
+var githubAutolinks_examples = require('./githubAutolinks.examples.cjs.js');
+var helpers = require('./helpers.cjs.js');
+
+function createGithubAutolinksAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "github:autolinks:create",
+    description: "Create an autolink reference for a repository",
+    examples: githubAutolinks_examples.examples,
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl", "keyPrefix", "urlTemplate"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,
+            type: "string"
+          },
+          keyPrefix: {
+            title: "Key Prefix",
+            description: "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.",
+            type: "string"
+          },
+          urlTemplate: {
+            title: "URL Template",
+            description: "The URL must contain <num> for the reference number. <num> matches different characters depending on the value of isAlphanumeric.",
+            type: "string"
+          },
+          isAlphanumeric: {
+            title: "Alphanumeric",
+            description: "Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters. Default: true",
+            type: "boolean"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The token to use for authorization to GitHub"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const { repoUrl, keyPrefix, urlTemplate, isAlphanumeric, token } = ctx.input;
+      ctx.logger.info(`Creating autolink reference for repo ${repoUrl}`);
+      const { owner, repo } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
+      if (!owner) {
+        throw new errors.InputError("Invalid repository owner provided in repoUrl");
+      }
+      const client = new octokit.Octokit(
+        await helpers.getOctokitOptions({
+          integrations,
+          repoUrl,
+          credentialsProvider: githubCredentialsProvider,
+          token
+        })
+      );
+      await client.rest.repos.createAutolink({
+        owner,
+        repo,
+        key_prefix: keyPrefix,
+        url_template: urlTemplate,
+        is_alphanumeric: isAlphanumeric
+      });
+      ctx.logger.info(`Autolink reference created successfully`);
+    }
+  });
+}
+
+exports.createGithubAutolinksAction = createGithubAutolinksAction;
+//# sourceMappingURL=githubAutolinks.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"githubAutolinks.cjs.js","sources":["../../src/actions/githubAutolinks.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { Octokit } from 'octokit';\nimport { examples } from './githubAutolinks.examples';\nimport { getOctokitOptions } from './helpers';\n\n/**\n * Create an autolink reference for a repository\n * @public\n */\nexport function createGithubAutolinksAction(options: {\n  integrations: ScmIntegrations;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, githubCredentialsProvider } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    keyPrefix: string;\n    urlTemplate: string;\n    isAlphanumeric?: boolean;\n    token?: string;\n  }>({\n    id: 'github:autolinks:create',\n    description: 'Create an autolink reference for a repository',\n    examples,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'keyPrefix', 'urlTemplate'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,\n            type: 'string',\n          },\n          keyPrefix: {\n            title: 'Key Prefix',\n            description:\n              'This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.',\n            type: 'string',\n          },\n          urlTemplate: {\n            title: 'URL Template',\n            description:\n              'The URL must contain <num> for the reference number. <num> matches different characters depending on the value of isAlphanumeric.',\n            type: 'string',\n          },\n          isAlphanumeric: {\n            title: 'Alphanumeric',\n            description:\n              'Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters. Default: true',\n            type: 'boolean',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { repoUrl, keyPrefix, urlTemplate, isAlphanumeric, token } =\n        ctx.input;\n\n      ctx.logger.info(`Creating autolink reference for repo ${repoUrl}`);\n\n      const { owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const client = new Octokit(\n        await getOctokitOptions({\n          integrations,\n          repoUrl,\n          credentialsProvider: githubCredentialsProvider,\n          token,\n        }),\n      );\n\n      await client.rest.repos.createAutolink({\n        owner,\n        repo,\n        key_prefix: keyPrefix,\n        url_template: urlTemplate,\n        is_alphanumeric: isAlphanumeric,\n      });\n\n      ctx.logger.info(`Autolink reference created successfully`);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","parseRepoUrl","InputError","Octokit","getOctokitOptions"],"mappings":";;;;;;;;AAiCO,SAAS,4BAA4B,OAGzC,EAAA;AACD,EAAM,MAAA,EAAE,YAAc,EAAA,yBAAA,EAA8B,GAAA,OAAA,CAAA;AAEpD,EAAA,OAAOA,yCAMJ,CAAA;AAAA,IACD,EAAI,EAAA,yBAAA;AAAA,IACJ,WAAa,EAAA,+CAAA;AAAA,cACbC,iCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAU,EAAA,CAAC,SAAW,EAAA,WAAA,EAAa,aAAa,CAAA;AAAA,QAChD,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,CAAA,gJAAA,CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,WACE,EAAA,4HAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,WACE,EAAA,mIAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,KAAO,EAAA,cAAA;AAAA,YACP,WACE,EAAA,wQAAA;AAAA,YACF,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,8CAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,OAAS,EAAA,SAAA,EAAW,aAAa,cAAgB,EAAA,KAAA,KACvD,GAAI,CAAA,KAAA,CAAA;AAEN,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAwC,qCAAA,EAAA,OAAO,CAAE,CAAA,CAAA,CAAA;AAEjE,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AAE1D,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA,CAAA;AAAA,OACrE;AAEA,MAAA,MAAM,SAAS,IAAIC,eAAA;AAAA,QACjB,MAAMC,yBAAkB,CAAA;AAAA,UACtB,YAAA;AAAA,UACA,OAAA;AAAA,UACA,mBAAqB,EAAA,yBAAA;AAAA,UACrB,KAAA;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAEA,MAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,cAAe,CAAA;AAAA,QACrC,KAAA;AAAA,QACA,IAAA;AAAA,QACA,UAAY,EAAA,SAAA;AAAA,QACZ,YAAc,EAAA,WAAA;AAAA,QACd,eAAiB,EAAA,cAAA;AAAA,OAClB,CAAA,CAAA;AAED,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAyC,uCAAA,CAAA,CAAA,CAAA;AAAA,KAC3D;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

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

@@ -0,0 +1,30 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "GitHub alphanumric autolink reference",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "github:autolinks:create",
+          name: "Create an autolink reference",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            keyPrefix: "TICKET-",
+            urlTemplate: "https://example.com/TICKET?query=<num>",
+            isAlphanumeric: false
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=githubAutolinks.examples.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"githubAutolinks.examples.cjs.js","sources":["../../src/actions/githubAutolinks.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 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: 'GitHub alphanumric autolink reference',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'github:autolinks:create',\n          name: 'Create an autolink reference',\n          input: {\n            repoUrl: 'github.com?repo=repo&owner=owner',\n            keyPrefix: 'TICKET-',\n            urlTemplate: 'https://example.com/TICKET?query=<num>',\n            isAlphanumeric: false,\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,uCAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,yBAAA;AAAA,UACR,IAAM,EAAA,8BAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,SAAA;AAAA,YACX,WAAa,EAAA,wCAAA;AAAA,YACb,cAAgB,EAAA,KAAA;AAAA,WAClB;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}