@backstage/plugin-scaffolder-backend 1.6.0-next.3 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.6.0
+
+### Minor Changes
+
+- ea2eee9e6a: Add the option for a homepage when using the `github:publish` action
+- 8872cc735d: Fixed a bug in plugin-scaffolder-backend where it ignores the skip migration database options.
+
+  To use this new implementation you need to create the instance of `DatabaseTaskStore` using the `PluginDatabaseManager` instead of `Knex`;
+
+  ```
+  import { DatabaseManager, getRootLogger, loadBackendConfig } from '@backstage/backend-common';
+  import { DatabaseTaskStore } from '@backstage/plugin-scaffolder-backend';
+
+  const config = await loadBackendConfig({ argv: process.argv, logger: getRootLogger() });
+  const databaseManager = DatabaseManager.fromConfig(config, { migrations: { skip: true } });
+  const databaseTaskStore = await DatabaseTaskStore.create(databaseManager);
+  ```
+
+- 7db9613671: Added `projectId` for gitlab projects to be displayed in the `gitlab:publish` output
+- d1f7ba58e3: Added `repositoryId` output when create a repository in Azure
+- 1ff817b3f0: add entity metadata to the template info type
+
+### Patch Changes
+
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- de8ee4afe3: Provide information about the user into scaffolder template action's context
+- 096631e571: Added support for handling broken symlinks within the scaffolder backend. This is intended for templates that may hold a symlink that is invalid at build time but valid within the destination repo.
+- 0d8d650e32: Applied the fix from version 1.5.1 of this package, which is part of the v1.5.1 release of Backstage.
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- 2df9955f4a: Removed the depreacated `publish:file` action, use the template editor to test templates instead.
+- 0ecc9a6784: Properly set `ctx.isDryRun` when running actions in dry run mode. Also always log action inputs for debugging purposes when running in dry run mode.
+- 6b9f6c0a4d: Added alpha `scaffolderPlugin` to be used with experimental backend system.
+- 83c037cd46: Disable octokit throttling in publish:github:pull-request
+- 2cbd533426: Uptake the `IdentityApi` change to use `getIdentity` instead of `authenticate` for retrieving the logged in users identity.
+- ef9ab322de: Minor API signatures cleanup
+- 50467bc15b: The number of task workers used to execute templates now default to 3, rather than 1.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.1.2
+  - @backstage/backend-common@0.15.1
+  - @backstage/plugin-auth-node@0.2.5
+  - @backstage/plugin-catalog-node@1.1.0
+  - @backstage/integration@1.3.1
+  - @backstage/plugin-catalog-backend@1.4.0
+  - @backstage/catalog-client@1.1.0
+  - @backstage/catalog-model@1.1.1
+  - @backstage/config@1.0.2
+  - @backstage/errors@1.1.1
+  - @backstage/plugin-scaffolder-common@1.2.0
+
 ## 1.6.0-next.3
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -32,6 +32,7 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UrlReader } from '@backstage/backend-common';
+import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 
 /**
@@ -55,6 +56,19 @@ export declare type ActionContext<Input extends JsonObject> = {
      * This will only ever be true if the actions as marked as supporting dry-runs.
      */
     isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
 };
 
 /**

package/dist/index.beta.d.ts

@@ -32,6 +32,7 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UrlReader } from '@backstage/backend-common';
+import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 
 /**
@@ -55,6 +56,19 @@ export declare type ActionContext<Input extends JsonObject> = {
      * This will only ever be true if the actions as marked as supporting dry-runs.
      */
     isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
 };
 
 /**

package/dist/index.cjs.js

@@ -4166,7 +4166,7 @@ class NunjucksWorkflowRunner {
     });
   }
   async execute(task) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g;
     if (!isValidTaskSpec(task.spec)) {
       throw new errors.InputError(
         "Wrong template version executed with the workflow engine"
@@ -4215,30 +4215,53 @@ class NunjucksWorkflowRunner {
           });
           const action = this.options.actionRegistry.get(step.action);
           const { taskLogger, streamLogger } = createStepLogger({ task, step });
-          if (task.isDryRun && !action.supportsDryRun) {
-            task.emitLog(
-              `Skipping because ${action.id} does not support dry-run`,
+          if (task.isDryRun) {
+            const redactedSecrets = Object.fromEntries(
+              Object.entries((_a = task.secrets) != null ? _a : {}).map((secret) => [
+                secret[0],
+                "[REDACTED]"
+              ])
+            );
+            const debugInput = (_b = step.input && this.render(
+              step.input,
               {
-                stepId: step.id,
-                status: "skipped"
-              }
+                ...context,
+                secrets: redactedSecrets
+              },
+              renderTemplate
+            )) != null ? _b : {};
+            taskLogger.info(
+              `Running ${action.id} in dry-run mode with inputs (secrets redacted): ${JSON.stringify(
+                debugInput,
+                void 0,
+                2
+              )}`
             );
-            const outputSchema = (_a = action.schema) == null ? void 0 : _a.output;
-            if (outputSchema) {
-              context.steps[step.id] = {
-                output: generateExampleOutput(outputSchema)
-              };
-            } else {
-              context.steps[step.id] = { output: {} };
+            if (!action.supportsDryRun) {
+              task.emitLog(
+                `Skipping because ${action.id} does not support dry-run`,
+                {
+                  stepId: step.id,
+                  status: "skipped"
+                }
+              );
+              const outputSchema = (_c = action.schema) == null ? void 0 : _c.output;
+              if (outputSchema) {
+                context.steps[step.id] = {
+                  output: generateExampleOutput(outputSchema)
+                };
+              } else {
+                context.steps[step.id] = { output: {} };
+              }
+              continue;
             }
-            continue;
           }
-          const input = (_c = step.input && this.render(
+          const input = (_e = step.input && this.render(
             step.input,
-            { ...context, secrets: (_b = task.secrets) != null ? _b : {} },
+            { ...context, secrets: (_d = task.secrets) != null ? _d : {} },
             renderTemplate
-          )) != null ? _c : {};
-          if ((_d = action.schema) == null ? void 0 : _d.input) {
+          )) != null ? _e : {};
+          if ((_f = action.schema) == null ? void 0 : _f.input) {
             const validateResult = jsonschema.validate(
               input,
               action.schema.input
@@ -4254,7 +4277,7 @@ class NunjucksWorkflowRunner {
           const stepOutput = {};
           await action.handler({
             input,
-            secrets: (_e = task.secrets) != null ? _e : {},
+            secrets: (_g = task.secrets) != null ? _g : {},
             logger: taskLogger,
             logStream: streamLogger,
             workspacePath,
@@ -4268,7 +4291,9 @@ class NunjucksWorkflowRunner {
             output(name, value) {
               stepOutput[name] = value;
             },
-            templateInfo: task.spec.templateInfo
+            templateInfo: task.spec.templateInfo,
+            user: task.spec.user,
+            isDryRun: task.isDryRun
           });
           for (const tmpDir of tmpDirs) {
             await fs__default["default"].remove(tmpDir);