@backstage/plugin-scaffolder-backend 1.18.1 → 1.19.0-next.1

package/dist/cjs/{router-d7df4c2b.cjs.js → router-b3ae7270.cjs.js}

@@ -80,7 +80,7 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const examples$h = [
+const examples$l = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
@@ -104,7 +104,7 @@ function createCatalogRegisterAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$4,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
-    examples: examples$h,
+    examples: examples$l,
     schema: {
       input: {
         oneOf: [
@@ -228,7 +228,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$g = [
+const examples$k = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -272,7 +272,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$g,
+    examples: examples$k,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -286,7 +286,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$f = [
+const examples$j = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
@@ -325,7 +325,7 @@ function createFetchCatalogEntityAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$f,
+    examples: examples$j,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -400,7 +400,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$e = [
+const examples$i = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
@@ -438,7 +438,7 @@ function createDebugLogAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$1,
     description: "Writes a message into the log or lists all files in the workspace.",
-    examples: examples$e,
+    examples: examples$i,
     schema: {
       input: {
         type: "object",
@@ -485,7 +485,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$d = [
+const examples$h = [
   {
     description: "Waiting for 50 milliseconds",
     example: yaml__default["default"].stringify({
@@ -548,7 +548,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples: examples$d,
+    examples: examples$h,
     schema: {
       input: {
         type: "object",
@@ -593,7 +593,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$c = [
+const examples$g = [
   {
     description: "Downloads content and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -632,7 +632,7 @@ function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: ACTION_ID,
-    examples: examples$c,
+    examples: examples$g,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -669,7 +669,7 @@ function createFetchPlainAction(options) {
   });
 }
 
-const examples$b = [
+const examples$f = [
   {
     description: "Downloads a file and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -693,7 +693,7 @@ function createFetchPlainFileAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
-    examples: examples$b,
+    examples: examples$f,
     schema: {
       input: {
         type: "object",
@@ -961,7 +961,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$a = [
+const examples$e = [
   {
     description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
     example: yaml__default["default"].stringify({
@@ -997,7 +997,7 @@ function createFetchTemplateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:template",
     description: "Downloads a skeleton, templates variables into file and directory names and content, and places the result in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
-    examples: examples$a,
+    examples: examples$e,
     schema: {
       input: {
         type: "object",
@@ -1202,7 +1202,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$9 = [
+const examples$d = [
   {
     description: "Delete specified files",
     example: yaml__namespace.stringify({
@@ -1224,7 +1224,7 @@ const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
-    examples: examples$9,
+    examples: examples$d,
     schema: {
       input: {
         required: ["files"],
@@ -1261,7 +1261,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples$8 = [
+const examples$c = [
   {
     description: "Rename specified files ",
     example: yaml__namespace.stringify({
@@ -1287,7 +1287,7 @@ const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
-    examples: examples$8,
+    examples: examples$c,
     schema: {
       input: {
         required: ["files"],
@@ -1769,7 +1769,7 @@ async function validateAccessTeam(client, access) {
   }
 }
 
-const examples$7 = [
+const examples$b = [
   {
     description: "GitHub Action Workflow Without Inputs.",
     example: yaml__default["default"].stringify({
@@ -1830,7 +1830,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$7,
+    examples: examples$b,
     schema: {
       input: {
         type: "object",
@@ -1899,7 +1899,7 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$a = [
   {
     description: "Add labels to pull request or issue",
     example: yaml__default["default"].stringify({
@@ -1940,7 +1940,7 @@ function createGithubIssuesLabelAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
-    examples: examples$6,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -2263,7 +2263,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$5 = [
+const examples$9 = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default["default"].stringify({
@@ -2316,7 +2316,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$5,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -2423,7 +2423,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$4 = [
+const examples$8 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default["default"].stringify({
@@ -2475,7 +2475,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$4,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -2577,12 +2577,116 @@ function createGithubRepoPushAction(options) {
   });
 }
 
+const examples$7 = [
+  {
+    description: "Create a GitHub webhook for a repository",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook",
+            webhookSecret: "mysecret",
+            events: ["push"],
+            active: true,
+            contentType: "json",
+            insecureSsl: false,
+            token: "my-github-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub webhook with minimal configuration",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub webhook with custom events",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook",
+            events: ["push", "pull_request"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub webhook with JSON content type",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook",
+            contentType: "json"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub webhook with insecure SSL",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook",
+            insecureSsl: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create an inactive GitHub webhook",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:webhook",
+          name: "Create GitHub Webhook",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            webhookUrl: "https://example.com/my-webhook",
+            active: false
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubWebhookAction(options) {
   const { integrations, defaultWebhookSecret, githubCredentialsProvider } = options;
   const eventNames = webhooks.emitterEventNames.filter((event) => !event.includes("."));
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -2695,11 +2799,32 @@ function createGithubWebhookAction(options) {
   });
 }
 
+const examples$6 = [
+  {
+    description: "Example 1: Create and store a Deploy Key",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:deployKey:create",
+          name: "Create and store a Deploy Key",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            publicKey: "pubkey",
+            privateKey: "privkey",
+            deployKeyName: "Push Tags"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubDeployKeyAction(options) {
   const { integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:deployKey:create",
     description: "Creates and stores Deploy Keys",
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -2802,11 +2927,92 @@ function createGithubDeployKeyAction(options) {
   });
 }
 
+const examples$5 = [
+  {
+    description: "Create a GitHub Environment (No Policies, No Variables, No Secrets)",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Protected Branch Policy",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: true,
+              custom_branch_policies: false
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Custom Branch Policies",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            deploymentBranchPolicy: {
+              protected_branches: false,
+              custom_branch_policies: true
+            },
+            customBranchPolicyNames: ["main", "*.*.*"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitHub Environment with Environment Variables and Secrets",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:environment:create",
+          name: "Create Environment",
+          input: {
+            repoUrl: "github.com?repo=repository&owner=owner",
+            name: "envname",
+            environmentVariables: {
+              key1: "val1",
+              key2: "val2"
+            },
+            secrets: {
+              secret1: "supersecret1",
+              secret2: "supersecret2"
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubEnvironmentAction(options) {
   const { integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -2949,7 +3155,7 @@ function createGithubEnvironmentAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$4 = [
   {
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     example: yaml__default["default"].stringify({
@@ -3004,7 +3210,7 @@ function createPublishAzureAction(options) {
   const { integrations, config } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:azure",
-    examples: examples$3,
+    examples: examples$4,
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     schema: {
       input: {
@@ -3146,7 +3352,7 @@ function createPublishAzureAction(options) {
   });
 }
 
-const examples$2 = [
+const examples$3 = [
   {
     description: "Initializes a git repository of contents in workspace and publish it to Bitbucket with default configuration.",
     example: yaml__default["default"].stringify({
@@ -3442,7 +3648,7 @@ function createPublishBitbucketAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:bitbucket",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Bitbucket.",
-    examples: examples$2,
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -4480,7 +4686,7 @@ Change-Id: ${changeId}`;
   });
 }
 
-const examples$1 = [
+const examples$2 = [
   {
     description: "Initializes a git repository of contents in workspace and publish it to GitHub with default configuration.",
     example: yaml__default["default"].stringify({
@@ -4536,7 +4742,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$1,
+    examples: examples$2,
     schema: {
       input: {
         type: "object",
@@ -4761,6 +4967,195 @@ async function deserializeDirectoryContents(targetPath, files) {
   }
 }
 
+const examples$1 = [
+  {
+    description: "Create a pull request",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with target branch name",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest with target branch name",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            targetBranchName: "test"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request as draft",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest as draft",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            draft: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with target path",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest with target path",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            targetPath: "targetPath"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with source path",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest with source path",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            sourcePath: "source"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with token",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            token: "gph_YourGitHubToken"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with reviewers",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest with reviewers",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            reviewers: ["foobar"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with team reviewers",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest with team reviewers",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            teamReviewers: ["team-foo"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with commit message",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            commitMessage: "Custom commit message"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a pull request with all parameters",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "publish:github:pull-request",
+          name: "Create a pull reuqest",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            branchName: "new-app",
+            title: "Create my new app",
+            description: "This PR is really good",
+            targetBranchName: "test",
+            draft: true,
+            targetPath: "targetPath",
+            sourcePath: "source",
+            token: "gph_YourGitHubToken",
+            reviewers: ["foobar"],
+            teamReviewers: ["team-foo"],
+            commitMessage: "Commit for foo changes"
+          }
+        }
+      ]
+    })
+  }
+];
+
 class GithubResponseError extends errors.CustomErrorBase {
 }
 const defaultClientFactory = async ({
@@ -4794,6 +5189,7 @@ const createPublishGithubPullRequestAction = (options) => {
   } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
+    examples: examples$1,
     schema: {
       input: {
         required: ["repoUrl", "title", "description", "branchName"],
@@ -4864,6 +5260,11 @@ const createPublishGithubPullRequestAction = (options) => {
             type: "string",
             title: "Commit Message",
             description: "The commit message for the pull request commit"
+          },
+          update: {
+            type: "boolean",
+            title: "Update",
+            description: "Update pull request if already exists"
           }
         }
       },
@@ -4901,7 +5302,8 @@ const createPublishGithubPullRequestAction = (options) => {
         token: providedToken,
         reviewers,
         teamReviewers,
-        commitMessage
+        commitMessage,
+        update
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -4961,7 +5363,8 @@ const createPublishGithubPullRequestAction = (options) => {
           ],
           body: description,
           head: branchName,
-          draft
+          draft,
+          update
         };
         if (targetBranchName) {
           createOptions.base = targetBranchName;
@@ -7317,8 +7720,10 @@ async function createRouter(options) {
       const token = userIdentity == null ? void 0 : userIdentity.token;
       const template = await authorizeTemplate(req.params, token);
       const parameters = [(_a2 = template.spec.parameters) != null ? _a2 : []].flat();
+      const presentation = template.spec.presentation;
       res.json({
         title: (_b = template.metadata.title) != null ? _b : template.metadata.name,
+        ...presentation ? { presentation } : {},
         description: template.metadata.description,
         "ui:options": template.metadata["ui:options"],
         steps: parameters.map((schema) => {
@@ -7630,4 +8035,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-d7df4c2b.cjs.js.map
+//# sourceMappingURL=router-b3ae7270.cjs.js.map