@backstage/plugin-scaffolder-backend 1.19.0-next.0 → 1.19.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.19.0-next.2
+
+### Patch Changes
+
+- [#20531](https://github.com/backstage/backstage/pull/20531) [`ae30a9ae8c`](https://github.com/backstage/backstage/commit/ae30a9ae8cbedc6df69c0656bf7044d1c869db40) Thanks [@andym0457](https://github.com/andym0457)! - Added description for publish:gerrit scaffolder actions
+
+- [#20570](https://github.com/backstage/backstage/pull/20570) [`013611b42e`](https://github.com/backstage/backstage/commit/013611b42ed457fefa9bb85fddf416cf5e0c1f76) Thanks [@freben](https://github.com/freben)! - `knex` has been bumped to major version 3 and `better-sqlite3` to major version 9, which deprecate node 16 support.
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.7-next.2
+  - @backstage/backend-common@0.19.9-next.2
+  - @backstage/plugin-catalog-backend@1.15.0-next.2
+  - @backstage/backend-tasks@0.5.12-next.2
+  - @backstage/plugin-auth-node@0.4.1-next.2
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.4-next.2
+  - @backstage/plugin-catalog-node@1.5.0-next.2
+  - @backstage/plugin-permission-node@0.7.18-next.2
+  - @backstage/plugin-scaffolder-node@0.2.8-next.2
+
+## 1.19.0-next.1
+
+### Patch Changes
+
+- 2be3922eb8: Add examples for `github:deployKey:create` scaffolder action & improve related tests
+- 76d07da66a: Make it possible to define control buttons text (Back, Create, Review) per template
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.15.0-next.1
+  - @backstage/plugin-catalog-node@1.5.0-next.1
+  - @backstage/integration@1.7.2-next.0
+  - @backstage/plugin-scaffolder-common@1.4.3-next.1
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.4-next.1
+  - @backstage/backend-common@0.19.9-next.1
+  - @backstage/plugin-scaffolder-node@0.2.8-next.1
+  - @backstage/backend-tasks@0.5.12-next.1
+  - @backstage/plugin-auth-node@0.4.1-next.1
+  - @backstage/plugin-permission-node@0.7.18-next.1
+  - @backstage/backend-plugin-api@0.6.7-next.1
+  - @backstage/catalog-client@1.4.5
+  - @backstage/catalog-model@1.4.3
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.17
+  - @backstage/plugin-permission-common@0.7.9
+
 ## 1.19.0-next.0
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.19.0-next.0",
+  "version": "1.19.0-next.2",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var router = require('./cjs/router-9c2e178f.cjs.js');
+var router = require('./cjs/router-04ab6217.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');

package/dist/cjs/{router-9c2e178f.cjs.js → router-04ab6217.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$k = [
+const examples$m = [
   {
     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$k,
+    examples: examples$m,
     schema: {
       input: {
         oneOf: [
@@ -228,7 +228,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$j = [
+const examples$l = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -272,7 +272,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$j,
+    examples: examples$l,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -286,7 +286,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$i = [
+const examples$k = [
   {
     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$i,
+    examples: examples$k,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -400,7 +400,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$h = [
+const examples$j = [
   {
     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$h,
+    examples: examples$j,
     schema: {
       input: {
         type: "object",
@@ -485,7 +485,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$g = [
+const examples$i = [
   {
     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$g,
+    examples: examples$i,
     schema: {
       input: {
         type: "object",
@@ -593,7 +593,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$f = [
+const examples$h = [
   {
     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$f,
+    examples: examples$h,
     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$e = [
+const examples$g = [
   {
     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$e,
+    examples: examples$g,
     schema: {
       input: {
         type: "object",
@@ -961,7 +961,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$d = [
+const examples$f = [
   {
     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$d,
+    examples: examples$f,
     schema: {
       input: {
         type: "object",
@@ -1202,7 +1202,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$c = [
+const examples$e = [
   {
     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$c,
+    examples: examples$e,
     schema: {
       input: {
         required: ["files"],
@@ -1261,7 +1261,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples$b = [
+const examples$d = [
   {
     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$b,
+    examples: examples$d,
     schema: {
       input: {
         required: ["files"],
@@ -1769,7 +1769,7 @@ async function validateAccessTeam(client, access) {
   }
 }
 
-const examples$a = [
+const examples$c = [
   {
     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$a,
+    examples: examples$c,
     schema: {
       input: {
         type: "object",
@@ -1899,7 +1899,7 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
-const examples$9 = [
+const examples$b = [
   {
     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$9,
+    examples: examples$b,
     schema: {
       input: {
         type: "object",
@@ -2263,7 +2263,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$8 = [
+const examples$a = [
   {
     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$8,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -2423,7 +2423,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$7 = [
+const examples$9 = [
   {
     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$7,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -2577,7 +2577,7 @@ function createGithubRepoPushAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$8 = [
   {
     description: "Create a GitHub webhook for a repository",
     example: yaml__default["default"].stringify({
@@ -2686,7 +2686,7 @@ function createGithubWebhookAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
-    examples: examples$6,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -2799,11 +2799,32 @@ function createGithubWebhookAction(options) {
   });
 }
 
+const examples$7 = [
+  {
+    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$7,
     schema: {
       input: {
         type: "object",
@@ -2906,7 +2927,7 @@ function createGithubDeployKeyAction(options) {
   });
 }
 
-const examples$5 = [
+const examples$6 = [
   {
     description: "Create a GitHub Environment (No Policies, No Variables, No Secrets)",
     example: yaml__default["default"].stringify({
@@ -2991,7 +3012,7 @@ function createGithubEnvironmentAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:environment:create",
     description: "Creates Deployment Environments",
-    examples: examples$5,
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -3134,7 +3155,7 @@ function createGithubEnvironmentAction(options) {
   });
 }
 
-const examples$4 = [
+const examples$5 = [
   {
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     example: yaml__default["default"].stringify({
@@ -3189,7 +3210,7 @@ function createPublishAzureAction(options) {
   const { integrations, config } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:azure",
-    examples: examples$4,
+    examples: examples$5,
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     schema: {
       input: {
@@ -3331,7 +3352,7 @@ function createPublishAzureAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$4 = [
   {
     description: "Initializes a git repository of contents in workspace and publish it to Bitbucket with default configuration.",
     example: yaml__default["default"].stringify({
@@ -3627,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$3,
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -4404,6 +4425,141 @@ function createPublishBitbucketServerPullRequestAction(options) {
   });
 }
 
+const examples$3 = [
+  {
+    description: "Initializes a Gerrit repository of contents in workspace and publish it to Gerrit with default configuration.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with a description.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            description: "Initialize a gerrit repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with a default Branch, if not set defaults to master",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            defaultBranch: "staging"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with an initial commit message, if not set defaults to initial commit",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            gitCommitMessage: "Initial Commit Message"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with a repo Author Name, if not set defaults to Scaffolder",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            gitAuthorName: "John Doe"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with a repo Author Email",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            gitAuthorEmail: "johndoe@email.com"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            sourcePath: "repository/"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a Gerrit repository with all proporties being set",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gerrit",
+          name: "Publish to Gerrit",
+          input: {
+            repoUrl: "gerrit.com?repo=repo&owner=owner",
+            description: "Initialize a gerrit repository",
+            defaultBranch: "staging",
+            gitCommitMessage: "Initial Commit Message",
+            gitAuthorName: "John Doe",
+            gitAuthorEmail: "johndoe@email.com",
+            sourcePath: "repository/"
+          }
+        }
+      ]
+    })
+  }
+];
+
 const createGerritProject = async (config, options) => {
   const { projectName, parent, owner, description } = options;
   const fetchOptions = {
@@ -4441,6 +4597,7 @@ function createPublishGerritAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:gerrit",
     description: "Initializes a git repository of the content in the workspace, and publishes it to Gerrit.",
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -7699,8 +7856,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) => {
@@ -8012,4 +8171,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-9c2e178f.cjs.js.map
+//# sourceMappingURL=router-04ab6217.cjs.js.map