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

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-scaffolder-backend-module-github
 
+## 0.1.1-next.0
+
+### Patch Changes
+
+- bf92ae3: Updated dependency `octokit` to `^3.0.0`.
+- Updated dependencies
+  - @backstage/backend-common@0.20.1-next.0
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/integration@1.8.0
+  - @backstage/plugin-scaffolder-node@0.2.10-next.0
+
+## 0.1.0
+
+### Minor Changes
+
+- 219d7f0: Create new scaffolder module for external integrations
+
+### Patch Changes
+
+- cb6a65e: The `scaffolder.defaultCommitMessage` config value is now being used if provided and uses "initial commit" when it is not provided.
+- 28949ea: Add a new action for creating github-autolink references for a repository: `github:autolinks:create`
+- Updated dependencies
+  - @backstage/backend-common@0.20.0
+  - @backstage/plugin-scaffolder-node@0.2.9
+  - @backstage/integration@1.8.0
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+
 ## 0.1.0-next.0
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -297,7 +297,7 @@ async function initRepoPushAndProtect(remoteUrl, password, workspacePath, source
     name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
     email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
   };
-  const commitMessage = gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage");
+  const commitMessage = getGitCommitMessage(gitCommitMessage, config) || "initial commit";
   const commitResult = await pluginScaffolderNode.initRepoAndPush({
     dir: pluginScaffolderNode.getRepoSourceDirectory(workspacePath, sourcePath),
     remoteUrl,
@@ -360,8 +360,11 @@ async function validateAccessTeam(client, access) {
     }
   }
 }
+function getGitCommitMessage(gitCommitMessage, config) {
+  return gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage");
+}
 
-const examples$8 = [
+const examples$9 = [
   {
     description: "GitHub Action Workflow Without Inputs.",
     example: yaml__default["default"].stringify({
@@ -422,7 +425,7 @@ function createGithubActionsDispatchAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
-    examples: examples$8,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -491,7 +494,7 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
-const examples$7 = [
+const examples$8 = [
   {
     description: "Add labels to pull request or issue",
     example: yaml__default["default"].stringify({
@@ -532,7 +535,7 @@ function createGithubIssuesLabelAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
-    examples: examples$7,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -855,7 +858,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$6 = [
+const examples$7 = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default["default"].stringify({
@@ -908,7 +911,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$6,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -1015,7 +1018,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$5 = [
+const examples$6 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default["default"].stringify({
@@ -1067,7 +1070,7 @@ function createGithubRepoPushAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:push",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
-    examples: examples$5,
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -1169,7 +1172,7 @@ function createGithubRepoPushAction(options) {
   });
 }
 
-const examples$4 = [
+const examples$5 = [
   {
     description: "Create a GitHub webhook for a repository",
     example: yaml__default["default"].stringify({
@@ -1278,7 +1281,7 @@ function createGithubWebhookAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
-    examples: examples$4,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -1391,7 +1394,7 @@ function createGithubWebhookAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$4 = [
   {
     description: "Example 1: Create and store a Deploy Key",
     example: yaml__default["default"].stringify({
@@ -1416,7 +1419,7 @@ function createGithubDeployKeyAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:deployKey:create",
     description: "Creates and stores Deploy Keys",
-    examples: examples$3,
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -1519,7 +1522,7 @@ function createGithubDeployKeyAction(options) {
   });
 }
 
-const examples$2 = [
+const examples$3 = [
   {
     description: "Create a GitHub Environment (No Policies, No Variables, No Secrets)",
     example: yaml__default["default"].stringify({
@@ -1604,7 +1607,7 @@ function createGithubEnvironmentAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
-    examples: examples$2,
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -1747,7 +1750,7 @@ function createGithubEnvironmentAction(options) {
   });
 }
 
-const examples$1 = [
+const examples$2 = [
   {
     description: "Create a pull request",
     example: yaml__default["default"].stringify({
@@ -1969,7 +1972,7 @@ const createPublishGithubPullRequestAction = (options) => {
   } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
-    examples: examples$1,
+    examples: examples$2,
     schema: {
       input: {
         required: ["repoUrl", "title", "description", "branchName"],
@@ -2197,7 +2200,7 @@ const createPublishGithubPullRequestAction = (options) => {
   }
 };
 
-const examples = [
+const examples$1 = [
   {
     description: "Initializes a git repository of contents in workspace and publish it to GitHub with default configuration.",
     example: yaml__default["default"].stringify({
@@ -2253,7 +2256,7 @@ function createPublishGithubAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
-    examples,
+    examples: examples$1,
     schema: {
       input: {
         type: "object",
@@ -2325,7 +2328,7 @@ function createPublishGithubAction(options) {
         protectDefaultBranch = true,
         protectEnforceAdmins = true,
         deleteBranchOnMerge = false,
-        gitCommitMessage = "initial commit",
+        gitCommitMessage,
         gitAuthorName,
         gitAuthorEmail,
         allowMergeCommit = true,
@@ -2414,7 +2417,94 @@ function createPublishGithubAction(options) {
   });
 }
 
+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
+          }
+        }
+      ]
+    })
+  }
+];
+
+function createGithubAutolinksAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "github:autolinks:create",
+    description: "Create an autolink reference for a repository",
+    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 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.createGithubActionsDispatchAction = createGithubActionsDispatchAction;
+exports.createGithubAutolinksAction = createGithubAutolinksAction;
 exports.createGithubDeployKeyAction = createGithubDeployKeyAction;
 exports.createGithubEnvironmentAction = createGithubEnvironmentAction;
 exports.createGithubIssuesLabelAction = createGithubIssuesLabelAction;