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

package/dist/cjs/{ScaffolderEntitiesProcessor-82f18a18.cjs.js → ScaffolderEntitiesProcessor-4b7489dd.cjs.js}

@@ -81,7 +81,7 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const examples$9 = [
+const examples$b = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
@@ -105,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$9,
+    examples: examples$b,
     schema: {
       input: {
         oneOf: [
@@ -229,7 +229,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$8 = [
+const examples$a = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -273,7 +273,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$8,
+    examples: examples$a,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -287,7 +287,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$7 = [
+const examples$9 = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
@@ -326,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$7,
+    examples: examples$9,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -401,7 +401,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$8 = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
@@ -439,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$6,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -486,7 +486,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$5 = [
+const examples$7 = [
   {
     description: "Waiting for 50 milliseconds",
     example: yaml__default["default"].stringify({
@@ -549,7 +549,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples: examples$5,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -594,7 +594,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$4 = [
+const examples$6 = [
   {
     description: "Downloads content and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -633,7 +633,7 @@ function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: ACTION_ID,
-    examples: examples$4,
+    examples: examples$6,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -670,7 +670,7 @@ function createFetchPlainAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$5 = [
   {
     description: "Downloads a file and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -694,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$3,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -962,7 +962,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$2 = [
+const examples$4 = [
   {
     description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
     example: yaml__default["default"].stringify({
@@ -998,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$2,
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -1203,7 +1203,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$1 = [
+const examples$3 = [
   {
     description: "Delete specified files",
     example: yaml__namespace.stringify({
@@ -1225,7 +1225,7 @@ const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
-    examples: examples$1,
+    examples: examples$3,
     schema: {
       input: {
         required: ["files"],
@@ -1262,7 +1262,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples = [
+const examples$2 = [
   {
     description: "Rename specified files ",
     example: yaml__namespace.stringify({
@@ -1288,7 +1288,7 @@ const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
-    examples,
+    examples: examples$2,
     schema: {
       input: {
         required: ["files"],
@@ -2170,11 +2170,60 @@ const commitHash = {
   type: "string"
 };
 
+const examples$1 = [
+  {
+    description: "Creates a GitHub repository with default configuration.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:create",
+          name: "Create a new GitHub repository",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Add a description.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:create",
+          name: "Create a new GitHub repository with a description",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            description: "My new repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Disable wiki and issues.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:create",
+          name: "Create a new GitHub repository without wiki and issues",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            hasIssues: false,
+            hasWiki: false
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubRepoCreateAction(options) {
   const { integrations, githubCredentialsProvider } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
+    examples: examples$1,
     schema: {
       input: {
         type: "object",
@@ -2281,11 +2330,59 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
+const examples = [
+  {
+    description: "Setup repo with no modifications to branch protection rules",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:push",
+          name: "Create test repo with testuser as owner.",
+          input: {
+            repoUrl: "github.com?repo=test&owner=testuser"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Setup repo with required codeowners check",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:push",
+          name: "Require codeowner branch protection rule",
+          input: {
+            repoUrl: "github.com?repo=reponame&owner=owner",
+            requireCodeOwnerReviews: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Change the default required number of approvals",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:repo:push",
+          name: "Require two approvals before merging",
+          input: {
+            repoUrl: "github.com?repo=reponame&owner=owner",
+            requiredApprovingReviewCount: 2
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubRepoPushAction(options) {
   const { integrations, config, githubCredentialsProvider } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:push",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
+    examples,
     schema: {
       input: {
         type: "object",
@@ -5797,7 +5894,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async executeStep(task, step, context, renderTemplate, taskTrack, workspacePath, decision) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
     const stepTrack = await this.tracker.stepStart(task, step);
     if (task.cancelSignal.aborted) {
       throw new Error(`Step ${step.name} has been cancelled.`);
@@ -5872,25 +5969,58 @@ class NunjucksWorkflowRunner {
       }
       const tmpDirs = new Array();
       const stepOutput = {};
-      await action.handler({
-        input,
-        secrets: (_g = task.secrets) != null ? _g : {},
-        logger: taskLogger,
-        logStream: streamLogger,
-        workspacePath,
-        createTemporaryDirectory: async () => {
-          const tmpDir = await fs__default["default"].mkdtemp(`${workspacePath}_step-${step.id}-`);
-          tmpDirs.push(tmpDir);
-          return tmpDir;
-        },
-        output(name, value) {
-          stepOutput[name] = value;
-        },
-        templateInfo: task.spec.templateInfo,
-        user: task.spec.user,
-        isDryRun: task.isDryRun,
-        signal: task.cancelSignal
-      });
+      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 : {};
+        }
+        await action.handler({
+          input: actionInput,
+          secrets: (_i = task.secrets) != null ? _i : {},
+          logger: taskLogger,
+          logStream: streamLogger,
+          workspacePath,
+          createTemporaryDirectory: async () => {
+            const tmpDir = await fs__default["default"].mkdtemp(
+              `${workspacePath}_step-${step.id}-`
+            );
+            tmpDirs.push(tmpDir);
+            return tmpDir;
+          },
+          output(name, value) {
+            if (step.each) {
+              stepOutput[name] = stepOutput[name] || [];
+              stepOutput[name].push(value);
+            } else {
+              stepOutput[name] = value;
+            }
+          },
+          templateInfo: task.spec.templateInfo,
+          user: task.spec.user,
+          isDryRun: task.isDryRun,
+          signal: task.cancelSignal
+        });
+      }
       for (const tmpDir of tmpDirs) {
         await fs__default["default"].remove(tmpDir);
       }
@@ -6371,6 +6501,7 @@ function buildDefaultIdentityClient(options) {
   };
 }
 async function createRouter(options) {
+  var _a;
   const router = Router__default["default"]();
   router.use(express__default["default"].json({ limit: "10MB" }));
   const {
@@ -6381,13 +6512,13 @@ async function createRouter(options) {
     catalogClient,
     actions,
     taskWorkers,
-    concurrentTasksLimit,
     scheduler,
     additionalTemplateFilters,
     additionalTemplateGlobals,
     permissions,
     permissionRules
   } = options;
+  const concurrentTasksLimit = (_a = options.concurrentTasksLimit) != null ? _a : options.config.getOptionalNumber("scaffolder.concurrentTasksLimit");
   const logger = parentLogger.child({ plugin: "scaffolder" });
   const identity = options.identity || buildDefaultIdentityClient(options);
   const workingDirectory = await getWorkingDirectory(config, logger);
@@ -6418,19 +6549,21 @@ async function createRouter(options) {
   }
   const actionRegistry = new TemplateActionRegistry();
   const workers = [];
-  for (let i = 0; i < (taskWorkers || 1); i++) {
-    const worker = await TaskWorker.create({
-      taskBroker,
-      actionRegistry,
-      integrations,
-      logger,
-      workingDirectory,
-      additionalTemplateFilters,
-      additionalTemplateGlobals,
-      concurrentTasksLimit,
-      permissions
-    });
-    workers.push(worker);
+  if (concurrentTasksLimit !== 0) {
+    for (let i = 0; i < (taskWorkers || 1); i++) {
+      const worker = await TaskWorker.create({
+        taskBroker,
+        actionRegistry,
+        integrations,
+        logger,
+        workingDirectory,
+        additionalTemplateFilters,
+        additionalTemplateGlobals,
+        concurrentTasksLimit,
+        permissions
+      });
+      workers.push(worker);
+    }
   }
   const actionsToRegister = Array.isArray(actions) ? actions : createBuiltinActions({
     integrations,
@@ -6482,21 +6615,21 @@ async function createRouter(options) {
   router.get(
     "/v2/templates/:namespace/:kind/:name/parameter-schema",
     async (req, res) => {
-      var _a, _b;
+      var _a2, _b;
       const userIdentity = await identity.getIdentity({
         request: req
       });
       const token = userIdentity == null ? void 0 : userIdentity.token;
       const template = await authorizeTemplate(req.params, token);
-      const parameters = [(_a = template.spec.parameters) != null ? _a : []].flat();
+      const parameters = [(_a2 = template.spec.parameters) != null ? _a2 : []].flat();
       res.json({
         title: (_b = template.metadata.title) != null ? _b : template.metadata.name,
         description: template.metadata.description,
         "ui:options": template.metadata["ui:options"],
         steps: parameters.map((schema) => {
-          var _a2;
+          var _a3;
           return {
-            title: (_a2 = schema.title) != null ? _a2 : "Please enter the following information",
+            title: (_a3 = schema.title) != null ? _a3 : "Please enter the following information",
             description: schema.description,
             schema
           };
@@ -6514,7 +6647,7 @@ async function createRouter(options) {
     });
     res.json(actionsList);
   }).post("/v2/tasks", async (req, res) => {
-    var _a, _b;
+    var _a2, _b;
     const templateRef = req.body.templateRef;
     const { kind, namespace, name } = catalogModel.parseEntityRef(templateRef, {
       defaultKind: "template"
@@ -6535,7 +6668,7 @@ async function createRouter(options) {
       { kind, namespace, name },
       token
     );
-    for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
+    for (const parameters of [(_a2 = template.spec.parameters) != null ? _a2 : []].flat()) {
       const result2 = jsonschema.validate(values, parameters);
       if (!result2.valid) {
         res.status(400).json({ errors: result2.errors });
@@ -6546,10 +6679,10 @@ async function createRouter(options) {
     const taskSpec = {
       apiVersion: template.apiVersion,
       steps: template.spec.steps.map((step, index) => {
-        var _a2, _b2;
+        var _a3, _b2;
         return {
           ...step,
-          id: (_a2 = step.id) != null ? _a2 : `step-${index + 1}`,
+          id: (_a3 = step.id) != null ? _a3 : `step-${index + 1}`,
           name: (_b2 = step.name) != null ? _b2 : step.action
         };
       }),
@@ -6599,9 +6732,9 @@ async function createRouter(options) {
     delete task.secrets;
     res.status(200).json(task);
   }).post("/v2/tasks/:taskId/cancel", async (req, res) => {
-    var _a;
+    var _a2;
     const { taskId } = req.params;
-    await ((_a = taskBroker.cancel) == null ? void 0 : _a.call(taskBroker, taskId));
+    await ((_a2 = taskBroker.cancel) == null ? void 0 : _a2.call(taskBroker, taskId));
     res.status(200).json({ status: "cancelled" });
   }).get("/v2/tasks/:taskId/eventstream", async (req, res) => {
     const { taskId } = req.params;
@@ -6620,7 +6753,7 @@ async function createRouter(options) {
         res.end();
       },
       next: ({ events }) => {
-        var _a;
+        var _a2;
         let shouldUnsubscribe = false;
         for (const event of events) {
           res.write(
@@ -6633,7 +6766,7 @@ data: ${JSON.stringify(event)}
             shouldUnsubscribe = true;
           }
         }
-        (_a = res.flush) == null ? void 0 : _a.call(res);
+        (_a2 = res.flush) == null ? void 0 : _a2.call(res);
         if (shouldUnsubscribe) {
           subscription.unsubscribe();
           res.end();
@@ -6667,7 +6800,7 @@ data: ${JSON.stringify(event)}
       clearTimeout(timeout);
     });
   }).post("/v2/dry-run", async (req, res) => {
-    var _a, _b, _c, _d;
+    var _a2, _b, _c, _d;
     const bodySchema = zod.z.object({
       template: zod.z.unknown(),
       values: zod.z.record(zod.z.unknown()),
@@ -6683,9 +6816,9 @@ data: ${JSON.stringify(event)}
     if (!await pluginScaffolderCommon.templateEntityV1beta3Validator.check(template)) {
       throw new errors.InputError("Input template is not a template");
     }
-    const token = (_a = await identity.getIdentity({
+    const token = (_a2 = await identity.getIdentity({
       request: req
-    })) == null ? void 0 : _a.token;
+    })) == null ? void 0 : _a2.token;
     for (const parameters of [(_b = template.spec.parameters) != null ? _b : []].flat()) {
       const result2 = jsonschema.validate(body.values, parameters);
       if (!result2.valid) {
@@ -6694,10 +6827,10 @@ data: ${JSON.stringify(event)}
       }
     }
     const steps = template.spec.steps.map((step, index) => {
-      var _a2, _b2;
+      var _a3, _b2;
       return {
         ...step,
-        id: (_a2 = step.id) != null ? _a2 : `step-${index + 1}`,
+        id: (_a3 = step.id) != null ? _a3 : `step-${index + 1}`,
         name: (_b2 = step.name) != null ? _b2 : step.action
       };
     });
@@ -6862,4 +6995,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-82f18a18.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-4b7489dd.cjs.js.map