@backstage/plugin-scaffolder-backend 1.15.2-next.1 → 1.15.2-next.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.15.2-next.2
+
+### Patch Changes
+
+- 33c76caef72a: Added examples for the fs:delete and fs:rename actions
+- 0b1d775be05b: Adds examples to a few scaffolder actions.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.12.0-next.2
+  - @backstage/backend-plugin-api@0.6.0-next.2
+  - @backstage/backend-tasks@0.5.5-next.2
+  - @backstage/plugin-scaffolder-node@0.1.6-next.2
+  - @backstage/backend-common@0.19.2-next.2
+  - @backstage/plugin-catalog-node@1.4.1-next.2
+  - @backstage/plugin-permission-node@0.7.11-next.2
+  - @backstage/plugin-auth-node@0.2.17-next.2
+
 ## 1.15.2-next.1
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -4,19 +4,22 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-1d387347.cjs.js');
+var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-82f18a18.cjs.js');
 var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
-require('path');
 require('@backstage/errors');
-require('globby');
+require('@backstage/catalog-model');
 require('fs-extra');
+require('yaml');
+require('zod');
+require('path');
+require('luxon');
+require('globby');
 require('isbinaryfile');
 require('isolated-vm');
-require('@backstage/catalog-model');
 require('lodash/get');
 require('azure-devops-node-api');
 require('node-fetch');
@@ -34,9 +37,6 @@ require('@backstage/plugin-scaffolder-common');
 require('express');
 require('express-promise-router');
 require('jsonschema');
-require('zod');
-require('yaml');
-require('luxon');
 require('uuid');
 require('winston');
 require('nunjucks');

package/dist/cjs/{ScaffolderEntitiesProcessor-1d387347.cjs.js → ScaffolderEntitiesProcessor-82f18a18.cjs.js}

@@ -81,14 +81,13 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const id$4 = "catalog:register";
-const examples$4 = [
+const examples$9 = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$4,
+          action: "catalog:register",
           id: "register-with-catalog",
           name: "Register with the catalog",
           input: {
@@ -99,12 +98,14 @@ const examples$4 = [
     })
   }
 ];
+
+const id$4 = "catalog:register";
 function createCatalogRegisterAction(options) {
   const { catalogClient, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: id$4,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
-    examples: examples$4,
+    examples: examples$9,
     schema: {
       input: {
         oneOf: [
@@ -228,14 +229,13 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const id$3 = "catalog:write";
-const examples$3 = [
+const examples$8 = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
       steps: [
         {
-          action: id$3,
+          action: "catalog:write",
           id: "create-catalog-info-file",
           name: "Create catalog file",
           input: {
@@ -258,6 +258,8 @@ const examples$3 = [
     })
   }
 ];
+
+const id$3 = "catalog:write";
 function createCatalogWriteAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$3,
@@ -271,7 +273,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$3,
+    examples: examples$8,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -285,14 +287,13 @@ function createCatalogWriteAction() {
   });
 }
 
-const id$2 = "catalog:fetch";
-const examples$2 = [
+const examples$7 = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$2,
+          action: "catalog:fetch",
           id: "fetch",
           name: "Fetch catalog entity",
           input: {
@@ -303,11 +304,11 @@ const examples$2 = [
     })
   },
   {
-    description: "Fetch multiple entities by referencse",
+    description: "Fetch multiple entities by reference",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$2,
+          action: "catalog:fetch",
           id: "fetchMultiple",
           name: "Fetch catalog entities",
           input: {
@@ -318,12 +319,14 @@ const examples$2 = [
     })
   }
 ];
+
+const id$2 = "catalog:fetch";
 function createFetchCatalogEntityAction(options) {
   const { catalogClient } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$2,
+    examples: examples$7,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -398,14 +401,13 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const id$1 = "debug:log";
-const examples$1 = [
+const examples$6 = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$1,
+          action: "debug:log",
           id: "write-debug-line",
           name: 'Write "Hello Backstage!" log line',
           input: {
@@ -420,7 +422,7 @@ const examples$1 = [
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id$1,
+          action: "debug:log",
           id: "write-workspace-directory",
           name: "List the workspace directory",
           input: {
@@ -431,11 +433,13 @@ const examples$1 = [
     })
   }
 ];
+
+const id$1 = "debug:log";
 function createDebugLogAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$1,
     description: "Writes a message into the log or lists all files in the workspace.",
-    examples: examples$1,
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -482,15 +486,28 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const id = "debug:wait";
-const MAX_WAIT_TIME_IN_ISO = "T00:00:30";
-const examples = [
+const examples$5 = [
+  {
+    description: "Waiting for 50 milliseconds",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "debug:wait",
+          id: "wait-milliseconds",
+          name: "Waiting for 50 milliseconds",
+          input: {
+            milliseconds: 50
+          }
+        }
+      ]
+    })
+  },
   {
     description: "Waiting for 5 seconds",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id,
+          action: "debug:wait",
           id: "wait-5sec",
           name: "Waiting for 5 seconds",
           input: {
@@ -501,21 +518,24 @@ const examples = [
     })
   },
   {
-    description: "Waiting for 5 minutes",
+    description: "Waiting for 1 minutes",
     example: yaml__default["default"].stringify({
       steps: [
         {
-          action: id,
-          id: "wait-5min",
-          name: "Waiting for 5 minutes",
+          action: "debug:wait",
+          id: "wait-1min",
+          name: "Waiting for 1 minutes",
           input: {
-            minutes: 5
+            minutes: 1
           }
         }
       ]
     })
   }
 ];
+
+const id = "debug:wait";
+const MAX_WAIT_TIME_IN_ISO = "T00:00:30";
 function createWaitAction(options) {
   const toDuration = (maxWaitTime) => {
     if (maxWaitTime) {
@@ -529,7 +549,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -574,10 +594,46 @@ function createWaitAction(options) {
   });
 }
 
+const examples$4 = [
+  {
+    description: "Downloads content and places it in the workspace.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain",
+          id: "fetch-plain",
+          name: "Fetch plain",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Optionally, if you would prefer the data to be downloaded to a subdirectory in the workspace you may specify the \u2018targetPath\u2019 input option.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain",
+          id: "fetch-plain",
+          name: "Fetch plain",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets",
+            targetPath: "fetched-data"
+          }
+        }
+      ]
+    })
+  }
+];
+
+const ACTION_ID = "fetch:plain";
 function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
-    id: "fetch:plain",
+    id: ACTION_ID,
+    examples: examples$4,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -614,11 +670,31 @@ function createFetchPlainAction(options) {
   });
 }
 
+const examples$3 = [
+  {
+    description: "Downloads a file and places it in the workspace.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:plain:file",
+          id: "fetch-plain-file",
+          name: "Fetch plain file",
+          input: {
+            url: "https://github.com/backstage/community/tree/main/backstage-community-sessions/assets/Backstage%20Community%20Sessions.png",
+            targetPath: "target-path"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createFetchPlainFileAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -886,6 +962,31 @@ const createDefaultFilters = ({
   };
 };
 
+const examples$2 = [
+  {
+    description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "fetch:template",
+          id: "fetch-template",
+          name: "Fetch template",
+          input: {
+            url: "./skeleton",
+            targetPath: "./target",
+            values: {
+              name: "test-project",
+              count: 1234,
+              itemList: ["first", "second", "third"],
+              showDummyFile: false
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createFetchTemplateAction(options) {
   const {
     reader,
@@ -897,6 +998,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$2,
     schema: {
       input: {
         type: "object",
@@ -1101,10 +1203,29 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
+const examples$1 = [
+  {
+    description: "Delete specified files",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "fs:delete",
+          id: "deleteFiles",
+          name: "Delete files",
+          input: {
+            files: ["file1.txt", "file2.txt"]
+          }
+        }
+      ]
+    })
+  }
+];
+
 const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
+    examples: examples$1,
     schema: {
       input: {
         required: ["files"],
@@ -1141,10 +1262,33 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
+const examples = [
+  {
+    description: "Rename specified files ",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "fs:rename",
+          id: "renameFiles",
+          name: "Rename files",
+          input: {
+            files: [
+              { from: "file1.txt", to: "file1Renamed.txt" },
+              { from: "file2.txt", to: "file2Renamed.txt" },
+              { from: "file3.txt", to: "file3Renamed.txt", overwrite: true }
+            ]
+          }
+        }
+      ]
+    })
+  }
+];
+
 const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
+    examples,
     schema: {
       input: {
         required: ["files"],
@@ -6718,4 +6862,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-1d387347.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-82f18a18.cjs.js.map