@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220712025512 → 0.0.0-nightly-20220715025616

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220712025512
+## 0.0.0-nightly-20220715025616
 
 ### Minor Changes
 
@@ -10,14 +10,21 @@
 
 ### 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
 - af02f54483: new setUserAsOwner flag for publish:gitlab action
 
   The field default is `false`. When true it will use the token configured in the gitlab integration for the matching host, to try and set the user logged in via `repoUrlPicker` `requestUserCredentials` OAuth flow as owner of the repository created in GitLab.
 
 - a70869e775: Updated dependency `msw` to `^0.43.0`.
+- 4e9a90e307: Updated dependency `luxon` to `^3.0.0`.
 - 72622d9143: Updated dependency `yaml` to `^2.0.0`.
+- 8006d0f9bf: Updated dependency `msw` to `^0.44.0`.
 - 679b32172e: Updated dependency `knex` to `^2.0.0`.
 - 511f49ee43: Updated dependency `octokit` to `^2.0.0`.
 - 735853353b: Updated dependency `@octokit/webhooks` to `^10.0.0`.
@@ -30,16 +37,45 @@
   - SNYK-JS-PARSEURL-2935947
   - SNYK-JS-PARSEURL-2936249
 
+- 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-20220715025616
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220715025616
+  - @backstage/backend-common@0.0.0-nightly-20220715025616
+  - @backstage/catalog-model@0.0.0-nightly-20220715025616
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20220715025616
+  - @backstage/integration@0.0.0-nightly-20220715025616
+  - @backstage/catalog-client@0.0.0-nightly-20220715025616
+  - @backstage/errors@0.0.0-nightly-20220715025616
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220715025616
+
+## 1.4.0-next.3
+
+### Minor Changes
+
+- 91c1d12123: Export experimental `scaffolderCatalogExtension` for the new backend system. This export is not considered stable and should not be used in production.
+
+### Patch Changes
+
+- ea6dcb84a4: Don't resolve symlinks, treat them as binary files and copy them as-is
+- af02f54483: new setUserAsOwner flag for publish:gitlab action
+
+  The field default is `false`. When true it will use the token configured in the gitlab integration for the matching host, to try and set the user logged in via `repoUrlPicker` `requestUserCredentials` OAuth flow as owner of the repository created in GitLab.
+
+- a70869e775: Updated dependency `msw` to `^0.43.0`.
+- 4e9a90e307: Updated dependency `luxon` to `^3.0.0`.
+- 72622d9143: Updated dependency `yaml` to `^2.0.0`.
+- 511f49ee43: Updated dependency `octokit` to `^2.0.0`.
+- 735853353b: Updated dependency `@octokit/webhooks` to `^10.0.0`.
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.0.0-nightly-20220712025512
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220712025512
-  - @backstage/backend-common@0.0.0-nightly-20220712025512
-  - @backstage/catalog-model@0.0.0-nightly-20220712025512
-  - @backstage/plugin-catalog-node@0.0.0-nightly-20220712025512
-  - @backstage/catalog-client@0.0.0-nightly-20220712025512
-  - @backstage/integration@0.0.0-nightly-20220712025512
-  - @backstage/errors@0.0.0-nightly-20220712025512
-  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220712025512
+  - @backstage/backend-plugin-api@0.1.0-next.0
+  - @backstage/plugin-catalog-backend@1.3.0-next.3
+  - @backstage/plugin-catalog-node@1.0.0-next.0
+  - @backstage/backend-common@0.14.1-next.3
+  - @backstage/catalog-client@1.0.4-next.2
+  - @backstage/integration@1.2.2-next.3
+  - @backstage/catalog-model@1.1.0-next.3
 
 ## 1.4.0-next.2
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "0.0.0-nightly-20220712025512",
+  "version": "0.0.0-nightly-20220715025616",
   "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;
 }>;
 
@@ -268,7 +272,7 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 collaborators?: ({
 user: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
@@ -359,7 +363,7 @@ export declare function createPublishBitbucketAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
@@ -380,7 +384,7 @@ export declare function createPublishBitbucketCloudAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -397,7 +401,7 @@ export declare function createPublishBitbucketServerAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
@@ -433,6 +437,7 @@ defaultBranch?: string | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
+sourcePath?: string | undefined;
 }>;
 
 /**
@@ -461,7 +466,7 @@ allowMergeCommit?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 collaborators?: ({
 user: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
@@ -504,7 +509,7 @@ export declare function createPublishGitlabAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 gitCommitMessage?: string | 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;
 }>;
 
@@ -268,7 +272,7 @@ allowSquashMerge?: boolean | undefined;
 allowMergeCommit?: boolean | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 collaborators?: ({
 user: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
@@ -359,7 +363,7 @@ export declare function createPublishBitbucketAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
@@ -380,7 +384,7 @@ export declare function createPublishBitbucketCloudAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 }>;
@@ -397,7 +401,7 @@ export declare function createPublishBitbucketServerAction(options: {
 repoUrl: string;
 description?: string | undefined;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | undefined;
+repoVisibility?: "public" | "private" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
@@ -433,6 +437,7 @@ defaultBranch?: string | undefined;
 gitCommitMessage?: string | undefined;
 gitAuthorName?: string | undefined;
 gitAuthorEmail?: string | undefined;
+sourcePath?: string | undefined;
 }>;
 
 /**
@@ -461,7 +466,7 @@ allowMergeCommit?: boolean | undefined;
 sourcePath?: string | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 collaborators?: ({
 user: string;
 access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
@@ -504,7 +509,7 @@ export declare function createPublishGitlabAction(options: {
 }): TemplateAction<    {
 repoUrl: string;
 defaultBranch?: string | undefined;
-repoVisibility?: "private" | "public" | "internal" | undefined;
+repoVisibility?: "public" | "private" | "internal" | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
 gitCommitMessage?: string | 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");
       }
-      if (ctx.input.templateFileExtension && (ctx.input.copyWithoutRender || ctx.input.cookiecutterCompat)) {
-        throw new errors.InputError("Fetch action input extension incompatible with copyWithoutRender and cookiecutterCompat");
+      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 (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,23 +567,27 @@ 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);
           }
+          localOutputPath = renderTemplate(localOutputPath, context);
         } else {
-          renderFilename = renderContents = !nonTemplatedEntries.has(location);
+          renderContents = !nonTemplatedEntries.has(location);
+          if (renderFilename) {
+            localOutputPath = renderTemplate(localOutputPath, context);
+          } else {
+            localOutputPath = renderContents ? renderTemplate(localOutputPath, context) : localOutputPath;
+          }
         }
-        if (renderFilename) {
-          localOutputPath = renderTemplate(localOutputPath, context);
+        if (containsSkippedContent(localOutputPath)) {
+          continue;
         }
         const outputPath = backendCommon.resolveSafeChildPath(outputDir, localOutputPath);
-        if (outputDir === outputPath) {
+        if (fs__default["default"].existsSync(outputPath)) {
           continue;
         }
         if (!renderContents && !extension) {
@@ -589,6 +614,9 @@ function createFetchTemplateAction(options) {
     }
   });
 }
+function containsSkippedContent(localOutputPath) {
+  return localOutputPath === "" || path__default["default"].isAbsolute(localOutputPath) || localOutputPath.includes(`${path__default["default"].sep}${path__default["default"].sep}`);
+}
 
 const createFilesystemDeleteAction = () => {
   return createTemplateAction({
@@ -729,7 +757,7 @@ const parseRepoUrl = (repoUrl, integrations) => {
       throw new errors.InputError(`Invalid repo URL passed to publisher: ${repoUrl}, missing project`);
     }
   } else {
-    if (!owner) {
+    if (!owner && type !== "gerrit") {
       throw new errors.InputError(`Invalid repo URL passed to publisher: ${repoUrl}, missing owner`);
     }
   }
@@ -2282,7 +2310,7 @@ const createGerritProject = async (config, options) => {
     body: JSON.stringify({
       parent,
       description,
-      owners: [owner],
+      owners: owner ? [owner] : [],
       create_empty_commit: false
     }),
     headers: {
@@ -2339,6 +2367,11 @@ function createPublishGerritAction(options) {
             title: "Default Author Email",
             type: "string",
             description: `Sets the default author email for the commit.`
+          },
+          sourcePath: {
+            title: "Source Path",
+            type: "string",
+            description: `Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.`
           }
         }
       },
@@ -2363,16 +2396,14 @@ function createPublishGerritAction(options) {
         defaultBranch = "master",
         gitAuthorName,
         gitAuthorEmail,
-        gitCommitMessage = "initial commit"
+        gitCommitMessage = "initial commit",
+        sourcePath
       } = ctx.input;
       const { repo, host, owner, workspace } = parseRepoUrl(repoUrl, integrations);
       const integrationConfig = integrations.gerrit.byHost(host);
       if (!integrationConfig) {
         throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
       }
-      if (!owner) {
-        throw new errors.InputError(`Invalid URL provider was included in the repo URL to create ${ctx.input.repoUrl}, missing owner`);
-      }
       if (!workspace) {
         throw new errors.InputError(`Invalid URL provider was included in the repo URL to create ${ctx.input.repoUrl}, missing workspace`);
       }
@@ -2392,7 +2423,7 @@ function createPublishGerritAction(options) {
       };
       const remoteUrl = `${integrationConfig.config.cloneUrl}/a/${repo}`;
       await initRepoAndPush({
-        dir: getRepoSourceDirectory(ctx.workspacePath, void 0),
+        dir: getRepoSourceDirectory(ctx.workspacePath, sourcePath),
         remoteUrl,
         auth,
         defaultBranch,