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

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

@@ -1,6 +1,7 @@
 'use strict';
 
 var catalogModel = require('@backstage/catalog-model');
+var config = require('@backstage/config');
 var errors = require('@backstage/errors');
 var integration = require('@backstage/integration');
 var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
@@ -80,7 +81,7 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const examples$l = [
+const examples$m = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
@@ -104,7 +105,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$l,
+    examples: examples$m,
     schema: {
       input: {
         oneOf: [
@@ -228,7 +229,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$k = [
+const examples$l = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -272,7 +273,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$k,
+    examples: examples$l,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -286,7 +287,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$j = [
+const examples$k = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
@@ -325,7 +326,7 @@ function createFetchCatalogEntityAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$j,
+    examples: examples$k,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -400,7 +401,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$i = [
+const examples$j = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
@@ -438,7 +439,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$i,
+    examples: examples$j,
     schema: {
       input: {
         type: "object",
@@ -485,7 +486,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$h = [
+const examples$i = [
   {
     description: "Waiting for 50 milliseconds",
     example: yaml__default["default"].stringify({
@@ -548,7 +549,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples: examples$h,
+    examples: examples$i,
     schema: {
       input: {
         type: "object",
@@ -593,7 +594,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$g = [
+const examples$h = [
   {
     description: "Downloads content and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -632,7 +633,7 @@ function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: ACTION_ID,
-    examples: examples$g,
+    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 +670,7 @@ function createFetchPlainAction(options) {
   });
 }
 
-const examples$f = [
+const examples$g = [
   {
     description: "Downloads a file and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -693,7 +694,7 @@ function createFetchPlainFileAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
-    examples: examples$f,
+    examples: examples$g,
     schema: {
       input: {
         type: "object",
@@ -961,7 +962,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$e = [
+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 +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$e,
+    examples: examples$f,
     schema: {
       input: {
         type: "object",
@@ -1110,17 +1111,13 @@ function createFetchTemplateAction(options) {
         followSymbolicLinks: false
       });
       const nonTemplatedEntries = new Set(
-        (await Promise.all(
-          (copyOnlyPatterns || []).map(
-            (pattern) => globby__default["default"](pattern, {
-              cwd: templateDir,
-              dot: true,
-              onlyFiles: false,
-              markDirectories: true,
-              followSymbolicLinks: false
-            })
-          )
-        )).flat()
+        await globby__default["default"](copyOnlyPatterns || [], {
+          cwd: templateDir,
+          dot: true,
+          onlyFiles: false,
+          markDirectories: true,
+          followSymbolicLinks: false
+        })
       );
       const { cookiecutterCompat, values } = ctx.input;
       const context = {
@@ -1202,7 +1199,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$d = [
+const examples$e = [
   {
     description: "Delete specified files",
     example: yaml__namespace.stringify({
@@ -1224,7 +1221,7 @@ const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
-    examples: examples$d,
+    examples: examples$e,
     schema: {
       input: {
         required: ["files"],
@@ -1261,7 +1258,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples$c = [
+const examples$d = [
   {
     description: "Rename specified files ",
     example: yaml__namespace.stringify({
@@ -1287,7 +1284,7 @@ const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
-    examples: examples$c,
+    examples: examples$d,
     schema: {
       input: {
         required: ["files"],
@@ -1769,7 +1766,7 @@ async function validateAccessTeam(client, access) {
   }
 }
 
-const examples$b = [
+const examples$c = [
   {
     description: "GitHub Action Workflow Without Inputs.",
     example: yaml__default["default"].stringify({
@@ -1830,7 +1827,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$b,
+    examples: examples$c,
     schema: {
       input: {
         type: "object",
@@ -1899,7 +1896,7 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
-const examples$a = [
+const examples$b = [
   {
     description: "Add labels to pull request or issue",
     example: yaml__default["default"].stringify({
@@ -1940,7 +1937,7 @@ function createGithubIssuesLabelAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
-    examples: examples$a,
+    examples: examples$b,
     schema: {
       input: {
         type: "object",
@@ -2263,7 +2260,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$9 = [
+const examples$a = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default["default"].stringify({
@@ -2316,7 +2313,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$9,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -2423,7 +2420,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$8 = [
+const examples$9 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default["default"].stringify({
@@ -2475,7 +2472,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$8,
+    examples: examples$9,
     schema: {
       input: {
         type: "object",
@@ -2577,7 +2574,7 @@ function createGithubRepoPushAction(options) {
   });
 }
 
-const examples$7 = [
+const examples$8 = [
   {
     description: "Create a GitHub webhook for a repository",
     example: yaml__default["default"].stringify({
@@ -2686,7 +2683,7 @@ function createGithubWebhookAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:webhook",
     description: "Creates webhook for a repository on GitHub.",
-    examples: examples$7,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -2799,7 +2796,7 @@ function createGithubWebhookAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$7 = [
   {
     description: "Example 1: Create and store a Deploy Key",
     example: yaml__default["default"].stringify({
@@ -2824,7 +2821,7 @@ function createGithubDeployKeyAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:deployKey:create",
     description: "Creates and stores Deploy Keys",
-    examples: examples$6,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -2927,7 +2924,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({
@@ -3012,7 +3009,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",
@@ -3155,7 +3152,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({
@@ -3210,7 +3207,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: {
@@ -3352,7 +3349,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({
@@ -3648,7 +3645,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",
@@ -4425,6 +4422,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 = {
@@ -4462,6 +4594,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",
@@ -6992,7 +7125,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async executeStep(task, step, context, renderTemplate, taskTrack, workspacePath, decision) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+    var _a, _b, _c, _d, _e;
     const stepTrack = await this.tracker.stepStart(task, step);
     if (task.cancelSignal.aborted) {
       throw new Error(`Step ${step.name} has been cancelled.`);
@@ -7042,59 +7175,61 @@ class NunjucksWorkflowRunner {
           return;
         }
       }
-      const input = (_e = step.input && this.render(
-        step.input,
-        { ...context, secrets: (_d = task.secrets) != null ? _d : {} },
-        renderTemplate
-      )) != null ? _e : {};
-      if ((_f = action.schema) == null ? void 0 : _f.input) {
-        const validateResult = jsonschema.validate(input, action.schema.input);
-        if (!validateResult.valid) {
-          const errors$1 = validateResult.errors.join(", ");
-          throw new errors.InputError(
-            `Invalid input passed to action ${action.id}, ${errors$1}`
+      const iterations = (step.each ? Object.entries(this.render(step.each, context, renderTemplate)).map(
+        ([key, value]) => ({
+          each: { key, value }
+        })
+      ) : [{}]).map((i) => ({
+        ...i,
+        // Secrets are only passed when templating the input to actions for security reasons
+        input: step.input ? this.render(
+          step.input,
+          { ...context, ...i, ...task },
+          renderTemplate
+        ) : {}
+      }));
+      for (const iteration of iterations) {
+        const actionId = action.id + (iteration.each ? `[${iteration.each.key}]` : "");
+        if ((_d = action.schema) == null ? void 0 : _d.input) {
+          const validateResult = jsonschema.validate(
+            iteration.input,
+            action.schema.input
+          );
+          if (!validateResult.valid) {
+            const errors$1 = validateResult.errors.join(", ");
+            throw new errors.InputError(
+              `Invalid input passed to action ${actionId}, ${errors$1}`
+            );
+          }
+        }
+        if (!isActionAuthorized(decision, {
+          action: action.id,
+          input: iteration.input
+        })) {
+          throw new errors.NotAllowedError(
+            `Unauthorized action: ${actionId}. The action is not allowed. Input: ${JSON.stringify(
+              iteration.input,
+              null,
+              2
+            )}`
           );
         }
       }
-      if (!isActionAuthorized(decision, { action: action.id, input })) {
-        throw new errors.NotAllowedError(
-          `Unauthorized action: ${action.id}. The action is not allowed. Input: ${JSON.stringify(
-            input,
-            null,
-            2
-          )}`
-        );
-      }
       const tmpDirs = new Array();
       const stepOutput = {};
-      const iterations = new Array();
-      if (step.each) {
-        const each = await this.render(step.each, context, renderTemplate);
-        iterations.push(
-          ...Object.keys(each).map((key) => {
-            return { key, value: each[key] };
-          })
-        );
-      } else {
-        iterations.push({});
-      }
-      let actionInput = input;
       for (const iteration of iterations) {
-        if (step.each) {
-          taskLogger.info(`Running step each: ${iteration}`);
-          const iterationContext = {
-            ...context,
-            each: iteration
-          };
-          actionInput = (_h = step.input && this.render(
-            step.input,
-            { ...iterationContext, secrets: (_g = task.secrets) != null ? _g : {} },
-            renderTemplate
-          )) != null ? _h : {};
+        if (iteration.each) {
+          taskLogger.info(
+            `Running step each: ${JSON.stringify(
+              iteration.each,
+              (k, v) => k ? v.toString() : v,
+              0
+            )}`
+          );
         }
         await action.handler({
-          input: actionInput,
-          secrets: (_i = task.secrets) != null ? _i : {},
+          input: iteration.input,
+          secrets: (_e = task.secrets) != null ? _e : {},
           logger: taskLogger,
           logStream: streamLogger,
           workspacePath,
@@ -7598,6 +7733,12 @@ function buildDefaultIdentityClient(options) {
     }
   };
 }
+const readDuration = (config$1, key, defaultValue) => {
+  if (config$1.has(key)) {
+    return config.readDurationFromConfig(config$1, { key });
+  }
+  return defaultValue;
+};
 async function createRouter(options) {
   var _a;
   const router = Router__default["default"]();
@@ -7628,12 +7769,21 @@ async function createRouter(options) {
     if (scheduler && databaseTaskStore.listStaleTasks) {
       await scheduler.scheduleTask({
         id: "close_stale_tasks",
-        frequency: { cron: "*/5 * * * *" },
-        // every 5 minutes, also supports Duration
+        frequency: readDuration(
+          config,
+          "scaffolder.taskTimeoutJanitorFrequency",
+          {
+            minutes: 5
+          }
+        ),
         timeout: { minutes: 15 },
         fn: async () => {
           const { tasks } = await databaseTaskStore.listStaleTasks({
-            timeoutS: 86400
+            timeoutS: luxon.Duration.fromObject(
+              readDuration(config, "scaffolder.taskTimeout", {
+                hours: 24
+              })
+            ).as("seconds")
           });
           for (const task of tasks) {
             await databaseTaskStore.shutdownTask(task);
@@ -8035,4 +8185,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-b3ae7270.cjs.js.map
+//# sourceMappingURL=router-6b5fa0be.cjs.js.map