@backstage/plugin-scaffolder-backend 1.22.6-next.2 → 1.22.6

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.22.6
+
+### Patch Changes
+
+- 131e5cb: Fix broken links in README.
+- 025641b: Fix issue with the log format not being respected when logging from actions
+- d229dc4: Move path utilities from `backend-common` to the `backend-plugin-api` package.
+- e4b50ab: Scaffolder workspace serialization
+- 025641b: Redact `meta` fields too with the logger
+- Updated dependencies
+  - @backstage/plugin-scaffolder-common@1.5.2
+  - @backstage/plugin-catalog-node@1.12.0
+  - @backstage/plugin-scaffolder-backend-module-github@0.2.8
+  - @backstage/plugin-scaffolder-backend-module-gitea@0.1.8
+  - @backstage/plugin-scaffolder-backend-module-gitlab@0.4.0
+  - @backstage/catalog-model@1.5.0
+  - @backstage/backend-common@0.22.0
+  - @backstage/backend-plugin-api@0.6.18
+  - @backstage/plugin-scaffolder-node@0.4.4
+  - @backstage/backend-tasks@0.5.23
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-server@0.1.8
+  - @backstage/plugin-auth-node@0.4.13
+  - @backstage/integration@1.11.0
+  - @backstage/catalog-client@1.6.5
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.16
+  - @backstage/plugin-permission-node@0.7.29
+  - @backstage/plugin-scaffolder-backend-module-azure@0.1.10
+  - @backstage/plugin-scaffolder-backend-module-bitbucket@0.2.8
+  - @backstage/plugin-scaffolder-backend-module-bitbucket-cloud@0.1.8
+  - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.10
+
 ## 1.22.6-next.2
 
 ### Patch Changes

package/README.md

@@ -1,9 +1,7 @@
 # Scaffolder Backend
 
-This is the backend for the default Backstage [software
-templates](https://backstage.io/docs/features/software-templates/).
-This provides the API for the frontend [scaffolder
-plugin](https://github.com/backstage/backstage/tree/master/plugins/scaffolder),
+This is the backend for the default Backstage [software templates](https://backstage.io/docs/features/software-templates/).
+This provides the API for the frontend [scaffolder plugin](https://github.com/backstage/backstage/tree/master/plugins/scaffolder),
 as well as the built-in template actions, tasks and stages.
 
 ## Installation
@@ -24,12 +22,19 @@ restoring the plugin, if you previously removed it.
 yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend
 ```
 
-### Adding the plugin to your `packages/backend`
+Then add the plugin to your backend, typically in `packages/backend/src/index.ts`:
 
-You'll need to add the plugin to the router in your `backend` package. You can
-do this by creating a file called `packages/backend/src/plugins/scaffolder.ts`
-with contents matching [scaffolder.ts in the create-app
-template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts).
+```ts
+const backend = createBackend();
+// ...
+backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));
+```
+
+#### Old backend system
+
+In the old backend system there's a bit more wiring required. You'll need to
+create a file called `packages/backend/src/plugins/scaffolder.ts`
+with contents matching [scaffolder.ts in the create-app template](https://github.com/backstage/backstage/blob/ad9314d3a7e0405719ba93badf96e97adde8ef83/packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts).
 
 With the `scaffolder.ts` router setup in place, add the router to
 `packages/backend/src/index.ts`:
@@ -54,10 +59,7 @@ async function main() {
 ### Adding templates
 
 At this point the scaffolder backend is installed in your backend package, but
-you will not have any templates available to use. These need to be [added to the
-software
-catalog](https://backstage.io/docs/features/software-templates/adding-templates).
+you will not have any templates available to use. These need to be [added to the software catalog](https://backstage.io/docs/features/software-templates/adding-templates).
 
 To get up and running and try out some templates quickly, you can or copy the
-catalog locations from the [create-app
-template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/app-config.yaml.hbs).
+catalog locations from the [create-app template](https://github.com/backstage/backstage/blob/master/packages/create-app/templates/default-app/app-config.yaml.hbs).

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var router = require('./cjs/router-DhoUgDz0.cjs.js');
+var router = require('./cjs/router-BKGs_U4O.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');

package/dist/cjs/{router-DhoUgDz0.cjs.js → router-BKGs_U4O.cjs.js}

@@ -14,6 +14,7 @@ var zod = require('zod');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var yaml = require('yaml');
 var fs = require('fs-extra');
+var backendPluginApi = require('@backstage/backend-plugin-api');
 var path = require('path');
 var luxon = require('luxon');
 var globby = require('globby');
@@ -286,7 +287,7 @@ function createCatalogWriteAction() {
       const entityRef = (_a = ctx.templateInfo) == null ? void 0 : _a.entityRef;
       const path = filePath != null ? filePath : "catalog-info.yaml";
       await fs__default.default.writeFile(
-        backendCommon.resolveSafeChildPath(ctx.workspacePath, path),
+        backendPluginApi.resolveSafeChildPath(ctx.workspacePath, path),
         yaml__namespace.stringify({
           ...entity,
           metadata: {
@@ -684,7 +685,7 @@ function createFetchPlainAction(options) {
       var _a, _b;
       ctx.logger.info("Fetching plain content from remote URL");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
-      const outputPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
+      const outputPath = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, targetPath);
       await pluginScaffolderNode.fetchContents({
         reader,
         integrations,
@@ -749,7 +750,7 @@ function createFetchPlainFileAction(options) {
     async handler(ctx) {
       var _a;
       ctx.logger.info("Fetching plain content from remote URL");
-      const outputPath = backendCommon.resolveSafeChildPath(
+      const outputPath = backendPluginApi.resolveSafeChildPath(
         ctx.workspacePath,
         ctx.input.targetPath
       );
@@ -860,7 +861,7 @@ class SecureTemplater {
     const context = await isolate.createContext();
     const contextGlobal = context.global;
     const nunjucksSource = await fs__default.default.readFile(
-      backendCommon.resolvePackagePath(
+      backendPluginApi.resolvePackagePath(
         "@backstage/plugin-scaffolder-backend",
         "assets/nunjucks.js.txt"
       ),
@@ -1045,9 +1046,9 @@ function createFetchTemplateAction(options) {
       var _a, _b;
       ctx.logger.info("Fetching template content from remote URL");
       const workDir = await ctx.createTemporaryDirectory();
-      const templateDir = backendCommon.resolveSafeChildPath(workDir, "template");
+      const templateDir = backendPluginApi.resolveSafeChildPath(workDir, "template");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
-      const outputDir = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
+      const outputDir = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, targetPath);
       if (ctx.input.copyWithoutRender && ctx.input.copyWithoutTemplating) {
         throw new errors.InputError(
           "Fetch action input copyWithoutRender and copyWithoutTemplating can not be used at the same time"
@@ -1147,7 +1148,7 @@ function createFetchTemplateAction(options) {
         if (containsSkippedContent(localOutputPath)) {
           continue;
         }
-        const outputPath = backendCommon.resolveSafeChildPath(outputDir, localOutputPath);
+        const outputPath = backendPluginApi.resolveSafeChildPath(outputDir, localOutputPath);
         if (fs__default.default.existsSync(outputPath) && !ctx.input.replace) {
           continue;
         }
@@ -1162,7 +1163,7 @@ function createFetchTemplateAction(options) {
           );
           await fs__default.default.ensureDir(outputPath);
         } else {
-          const inputFilePath = backendCommon.resolveSafeChildPath(templateDir, location);
+          const inputFilePath = backendPluginApi.resolveSafeChildPath(templateDir, location);
           const stats = await fs__default.default.promises.lstat(inputFilePath);
           if (stats.isSymbolicLink() || await isbinaryfile.isBinaryFile(inputFilePath)) {
             ctx.logger.info(
@@ -1237,7 +1238,7 @@ const createFilesystemDeleteAction = () => {
         throw new errors.InputError("files must be an Array");
       }
       for (const file of ctx.input.files) {
-        const filepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, file);
+        const filepath = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, file);
         try {
           await fs__default.default.remove(filepath);
           ctx.logger.info(`File ${filepath} deleted successfully`);
@@ -1318,11 +1319,11 @@ const createFilesystemRenameAction = () => {
         if (!file.from || !file.to) {
           throw new errors.InputError("each file must have a from and to property");
         }
-        const sourceFilepath = backendCommon.resolveSafeChildPath(
+        const sourceFilepath = backendPluginApi.resolveSafeChildPath(
           ctx.workspacePath,
           file.from
         );
-        const destFilepath = backendCommon.resolveSafeChildPath(ctx.workspacePath, file.to);
+        const destFilepath = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, file.to);
         try {
           await fs__default.default.move(sourceFilepath, destFilepath, {
             overwrite: (_b = file.overwrite) != null ? _b : false
@@ -1387,7 +1388,8 @@ const createBuiltinActions = (options) => {
     }),
     github.createPublishGithubPullRequestAction({
       integrations,
-      githubCredentialsProvider
+      githubCredentialsProvider,
+      config
     }),
     gitlab.createPublishGitlabAction({
       integrations,
@@ -1549,7 +1551,7 @@ var __publicField$3 = (obj, key, value) => {
   __defNormalProp$3(obj, key + "" , value);
   return value;
 };
-const migrationsDir = backendCommon.resolvePackagePath(
+const migrationsDir = backendPluginApi.resolvePackagePath(
   "@backstage/plugin-scaffolder-backend",
   "migrations"
 );
@@ -3154,7 +3156,7 @@ function createDryRunner(options) {
     });
     const dryRunId = uuid.v4();
     const log = new Array();
-    const contentsPath = backendCommon.resolveSafeChildPath(
+    const contentsPath = backendPluginApi.resolveSafeChildPath(
       options.workingDirectory,
       `dry-run-content-${dryRunId}`
     );
@@ -3175,7 +3177,7 @@ function createDryRunner(options) {
           templateInfo: {
             entityRef: "template:default/dry-run",
             baseUrl: url.pathToFileURL(
-              backendCommon.resolveSafeChildPath(contentsPath, "template.yaml")
+              backendPluginApi.resolveSafeChildPath(contentsPath, "template.yaml")
             ).toString()
           }
         },
@@ -3780,4 +3782,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-DhoUgDz0.cjs.js.map
+//# sourceMappingURL=router-BKGs_U4O.cjs.js.map