@backstage/plugin-scaffolder-backend 0.15.21 → 0.15.22

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.15.22
+
+### Patch Changes
+
+- b09dd8f43b: chore(deps): bump `@gitbeaker/node` from 34.6.0 to 35.1.0
+- ac2f1eeec0: This change is for adding the option of inputs on the `github:actions:dispatch` Backstage Action. This will allow users to pass data from Backstage to the GitHub Action.
+- 0d5e846a78: Expose a new option to provide additional template filters via `@backstage/scaffolder-backend`'s `createRouter()` function.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.21.1
+  - @backstage/backend-common@0.10.5
+
 ## 0.15.21
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -361,6 +361,12 @@ const { render, renderCompat } = (() => {
     });
   }
 
+  if (typeof additionalTemplateFilters !== 'undefined') {
+    for (const [filterName, filterFn] of Object.entries(additionalTemplateFilters)) {
+      env.addFilter(filterName, (...args) => JSON.parse(filterFn(...args)));
+    }
+  }
+
   let uninstallCompat = undefined;
 
   function render(str, values) {
@@ -393,12 +399,16 @@ const { render, renderCompat } = (() => {
 `;
 class SecureTemplater {
   static async loadRenderer(options = {}) {
-    const { parseRepoUrl, cookiecutterCompat } = options;
-    let sandbox = void 0;
+    const { parseRepoUrl, cookiecutterCompat, additionalTemplateFilters } = options;
+    const sandbox = {};
     if (parseRepoUrl) {
-      sandbox = {
-        parseRepoUrl: (url) => JSON.stringify(parseRepoUrl(url))
-      };
+      sandbox.parseRepoUrl = (url) => JSON.stringify(parseRepoUrl(url));
+    }
+    if (additionalTemplateFilters) {
+      sandbox.additionalTemplateFilters = Object.fromEntries(Object.entries(additionalTemplateFilters).filter(([_, filterFunction]) => !!filterFunction).map(([filterName, filterFunction]) => [
+        filterName,
+        (...args) => JSON.stringify(filterFunction(...args))
+      ]));
     }
     const vm = new vm2.VM({ sandbox });
     const nunjucksSource = await fs__default["default"].readFile(backendCommon.resolvePackagePath("@backstage/plugin-scaffolder-backend", "assets/nunjucks.js.txt"), "utf-8");
@@ -419,7 +429,7 @@ class SecureTemplater {
 }
 
 function createFetchTemplateAction(options) {
-  const { reader, integrations } = options;
+  const { reader, integrations, additionalTemplateFilters } = options;
   return 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.",
@@ -510,7 +520,8 @@ function createFetchTemplateAction(options) {
       };
       ctx.logger.info(`Processing ${allEntriesInTemplate.length} template files/directories with input values`, ctx.input.values);
       const renderTemplate = await SecureTemplater.loadRenderer({
-        cookiecutterCompat: ctx.input.cookiecutterCompat
+        cookiecutterCompat: ctx.input.cookiecutterCompat,
+        additionalTemplateFilters
       });
       for (const location of allEntriesInTemplate) {
         let renderFilename;
@@ -1772,19 +1783,25 @@ function createGithubActionsDispatchAction(options) {
             title: "Branch or Tag name",
             description: "The git branch or tag name used to dispatch the workflow",
             type: "string"
+          },
+          workflowInputs: {
+            title: "Workflow Inputs",
+            description: "Inputs keys and values to send to GitHub Action configured on the workflow file. The maximum number of properties is 10. ",
+            type: "object"
           }
         }
       }
     },
     async handler(ctx) {
-      const { repoUrl, workflowId, branchOrTagName } = ctx.input;
+      const { repoUrl, workflowId, branchOrTagName, workflowInputs } = ctx.input;
       ctx.logger.info(`Dispatching workflow ${workflowId} for repo ${repoUrl} on ${branchOrTagName}`);
       const { client, owner, repo } = await octokitProvider.getOctokit(repoUrl);
       await client.rest.actions.createWorkflowDispatch({
         owner,
         repo,
         workflow_id: workflowId,
-        ref: branchOrTagName
+        ref: branchOrTagName,
+        inputs: workflowInputs
       });
       ctx.logger.info(`Workflow ${workflowId} dispatched successfully`);
     }
@@ -1892,7 +1909,14 @@ function createGithubWebhookAction(options) {
 }
 
 const createBuiltinActions = (options) => {
-  const { reader, integrations, containerRunner, catalogClient, config } = options;
+  const {
+    reader,
+    integrations,
+    containerRunner,
+    catalogClient,
+    config,
+    additionalTemplateFilters
+  } = options;
   const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
   const actions = [
     createFetchPlainAction({
@@ -1901,7 +1925,8 @@ const createBuiltinActions = (options) => {
     }),
     createFetchTemplateAction({
       integrations,
-      reader
+      reader,
+      additionalTemplateFilters
     }),
     createPublishGithubAction({
       integrations,
@@ -2541,7 +2566,8 @@ class NunjucksWorkflowRunner {
     const renderTemplate = await SecureTemplater.loadRenderer({
       parseRepoUrl(url) {
         return parseRepoUrl(url, integrations);
-      }
+      },
+      additionalTemplateFilters: this.options.additionalTemplateFilters
     });
     try {
       await fs__default["default"].ensureDir(workspacePath);
@@ -2632,7 +2658,8 @@ class TaskWorker {
       logger,
       actionRegistry,
       integrations,
-      workingDirectory
+      workingDirectory,
+      additionalTemplateFilters
     } = options;
     const legacyWorkflowRunner = new HandlebarsWorkflowRunner({
       logger,
@@ -2644,7 +2671,8 @@ class TaskWorker {
       actionRegistry,
       integrations,
       logger,
-      workingDirectory
+      workingDirectory,
+      additionalTemplateFilters
     });
     return new TaskWorker({
       taskBroker,
@@ -2741,7 +2769,8 @@ async function createRouter(options) {
     catalogClient,
     actions,
     containerRunner,
-    taskWorkers
+    taskWorkers,
+    additionalTemplateFilters
   } = options;
   const logger = parentLogger.child({ plugin: "scaffolder" });
   const workingDirectory = await getWorkingDirectory(config, logger);
@@ -2764,7 +2793,8 @@ async function createRouter(options) {
       actionRegistry,
       integrations,
       logger,
-      workingDirectory
+      workingDirectory,
+      additionalTemplateFilters
     });
     workers.push(worker);
   }
@@ -2773,7 +2803,8 @@ async function createRouter(options) {
     catalogClient,
     containerRunner,
     reader,
-    config
+    config,
+    additionalTemplateFilters
   });
   actionsToRegister.forEach((action) => actionRegistry.register(action));
   workers.forEach((worker) => worker.start());