@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220714025131 → 0.0.0-nightly-20220717025420

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220714025131
+## 0.0.0-nightly-20220717025420
 
 ### Minor Changes
 
@@ -10,6 +10,10 @@
 
 ### Patch Changes
 
+- ff316b86d8: Add `copyWithoutTemplating` to the fetch template action input. `copyWithoutTemplating` also accepts an array of glob patterns. Contents of matched files or directories are copied without being processed, but paths are subject to rendering.
+
+  Deprecate `copyWithoutRender` in favor of `copyWithoutTemplating`.
+
 - 801d606909: Improve error messaging when passing in malformed auth
 - 089d846962: Fix issues with optional directories and files
 - ea6dcb84a4: Don't resolve symlinks, treat them as binary files and copy them as-is
@@ -36,15 +40,15 @@
 - 945a27fa6a: Add sourcePath option to publish:gerrit action
 - 1764296a68: Allow to create Gerrit project using default owner
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.0.0-nightly-20220714025131
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220714025131
-  - @backstage/backend-common@0.0.0-nightly-20220714025131
-  - @backstage/catalog-model@0.0.0-nightly-20220714025131
-  - @backstage/plugin-catalog-node@0.0.0-nightly-20220714025131
-  - @backstage/integration@0.0.0-nightly-20220714025131
-  - @backstage/catalog-client@0.0.0-nightly-20220714025131
-  - @backstage/errors@0.0.0-nightly-20220714025131
-  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220714025131
+  - @backstage/backend-plugin-api@0.0.0-nightly-20220717025420
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220717025420
+  - @backstage/backend-common@0.0.0-nightly-20220717025420
+  - @backstage/catalog-model@0.0.0-nightly-20220717025420
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20220717025420
+  - @backstage/integration@0.0.0-nightly-20220717025420
+  - @backstage/catalog-client@0.0.0-nightly-20220717025420
+  - @backstage/errors@0.0.0-nightly-20220717025420
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220717025420
 
 ## 1.4.0-next.3
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "0.0.0-nightly-20220714025131",
+  "version": "0.0.0-nightly-20220717025420",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -161,7 +161,11 @@ url: string;
 targetPath?: string | undefined;
 values: any;
 templateFileExtension?: string | boolean | undefined;
+/**
+* @deprecated This field is deprecated in favor of copyWithoutTemplating.
+*/
 copyWithoutRender?: string[] | undefined;
+copyWithoutTemplating?: string[] | undefined;
 cookiecutterCompat?: boolean | undefined;
 }>;
 

package/dist/index.beta.d.ts

@@ -161,7 +161,11 @@ url: string;
 targetPath?: string | undefined;
 values: any;
 templateFileExtension?: string | boolean | undefined;
+/**
+* @deprecated This field is deprecated in favor of copyWithoutTemplating.
+*/
 copyWithoutRender?: string[] | undefined;
+copyWithoutTemplating?: string[] | undefined;
 cookiecutterCompat?: boolean | undefined;
 }>;
 

package/dist/index.cjs.js

@@ -473,13 +473,21 @@ function createFetchTemplateAction(options) {
             type: "object"
           },
           copyWithoutRender: {
-            title: "Copy Without Render",
+            title: "[Deprecated] Copy Without Render",
             description: "An array of glob patterns. Any files or directories which match are copied without being processed as templates.",
             type: "array",
             items: {
               type: "string"
             }
           },
+          copyWithoutTemplating: {
+            title: "Copy Without Templating",
+            description: "An array of glob patterns. Contents of matched files or directories are copied without being processed, but paths are subject to rendering.",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
           cookiecutterCompat: {
             title: "Cookiecutter compatibility mode",
             description: "Enable features to maximise compatibility with templates built for fetch:cookiecutter",
@@ -501,11 +509,24 @@ function createFetchTemplateAction(options) {
       const templateDir = backendCommon.resolveSafeChildPath(workDir, "template");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
       const outputDir = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
-      if (ctx.input.copyWithoutRender && !Array.isArray(ctx.input.copyWithoutRender)) {
-        throw new errors.InputError("Fetch action input copyWithoutRender must be an Array");
+      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");
+      }
+      let copyOnlyPatterns;
+      let renderFilename;
+      if (ctx.input.copyWithoutRender) {
+        ctx.logger.warn("[Deprecated] Please use copyWithoutTemplating instead.");
+        copyOnlyPatterns = ctx.input.copyWithoutRender;
+        renderFilename = false;
+      } else {
+        copyOnlyPatterns = ctx.input.copyWithoutTemplating;
+        renderFilename = true;
       }
-      if (ctx.input.templateFileExtension && (ctx.input.copyWithoutRender || ctx.input.cookiecutterCompat)) {
-        throw new errors.InputError("Fetch action input extension incompatible with copyWithoutRender and cookiecutterCompat");
+      if (copyOnlyPatterns && !Array.isArray(copyOnlyPatterns)) {
+        throw new errors.InputError("Fetch action input copyWithoutRender/copyWithoutTemplating must be an Array");
+      }
+      if (ctx.input.templateFileExtension && (copyOnlyPatterns || ctx.input.cookiecutterCompat)) {
+        throw new errors.InputError("Fetch action input extension incompatible with copyWithoutRender/copyWithoutTemplating and cookiecutterCompat");
       }
       let extension = false;
       if (ctx.input.templateFileExtension) {
@@ -529,7 +550,7 @@ function createFetchTemplateAction(options) {
         markDirectories: true,
         followSymbolicLinks: false
       });
-      const nonTemplatedEntries = new Set((await Promise.all((ctx.input.copyWithoutRender || []).map((pattern) => globby__default["default"](pattern, {
+      const nonTemplatedEntries = new Set((await Promise.all((copyOnlyPatterns || []).map((pattern) => globby__default["default"](pattern, {
         cwd: templateDir,
         dot: true,
         onlyFiles: false,
@@ -546,20 +567,21 @@ function createFetchTemplateAction(options) {
         additionalTemplateFilters
       });
       for (const location of allEntriesInTemplate) {
-        let renderFilename;
         let renderContents;
         let localOutputPath = location;
         if (extension) {
-          renderFilename = true;
           renderContents = path.extname(localOutputPath) === extension;
           if (renderContents) {
             localOutputPath = localOutputPath.slice(0, -extension.length);
           }
-        } else {
-          renderFilename = renderContents = !nonTemplatedEntries.has(location);
-        }
-        if (renderFilename) {
           localOutputPath = renderTemplate(localOutputPath, context);
+        } else {
+          renderContents = !nonTemplatedEntries.has(location);
+          if (renderFilename) {
+            localOutputPath = renderTemplate(localOutputPath, context);
+          } else {
+            localOutputPath = renderContents ? renderTemplate(localOutputPath, context) : localOutputPath;
+          }
         }
         if (containsSkippedContent(localOutputPath)) {
           continue;