@backstage/plugin-scaffolder-backend 1.5.0-next.0 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.5.0
+
+### Minor Changes
+
+- c4b452e16a: Starting the implementation of the Wizard page for the `next` scaffolder plugin
+- 593dea6710: Add support for Basic Auth for Bitbucket Server.
+- 3b7930b3e5: Add support for Bearer Authorization header / token-based auth at Git commands.
+- 3f1316f1c5: User Bearer Authorization header at Git commands with token-based auth at Bitbucket Server.
+- eeff5046ae: Updated `publish:gitlab:merge-request` action to allow commit updates and deletes
+- 692d5d3405: Added `reviewers` and `teamReviewers` parameters to `publish:github:pull-request` action to add reviewers on the pull request created by the action
+
+### Patch Changes
+
+- fc8a5f797b: Add a `publish:gerrit:review` scaffolder action
+- c971afbf21: The `publish:file` action has been deprecated in favor of testing templates using the template editor instead. Note that this action is not and was never been installed by default.
+- b10b6c4aa4: Fix issue on Windows where templated files where not properly skipped as intended.
+- 56e1b4b89c: Fixed typos in alpha types.
+- dad0f65494: Fail gracefully if an invalid `Authorization` header is passed to `POST /v2/tasks`
+- 014b3b7776: Add missing `res.end()` in scaffolder backend `EventStream` usage
+- Updated dependencies
+  - @backstage/backend-common@0.15.0
+  - @backstage/backend-plugin-api@0.1.1
+  - @backstage/plugin-catalog-node@1.0.1
+  - @backstage/integration@1.3.0
+  - @backstage/plugin-catalog-backend@1.3.1
+
+## 1.5.0-next.2
+
+### Minor Changes
+
+- 692d5d3405: Added `reviewers` and `teamReviewers` parameters to `publish:github:pull-request` action to add reviewers on the pull request created by the action
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.3.1-next.2
+
+## 1.5.0-next.1
+
+### Minor Changes
+
+- c4b452e16a: Starting the implementation of the Wizard page for the `next` scaffolder plugin
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.15.0-next.1
+  - @backstage/integration@1.3.0-next.1
+  - @backstage/plugin-catalog-backend@1.3.1-next.1
+
 ## 1.5.0-next.0
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -6,7 +6,7 @@
 
 /// <reference types="node" />
 
-import { BackendRegistrable } from '@backstage/backend-plugin-api';
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -418,6 +419,7 @@ token?: string | undefined;
  * production, as it writes the files to the local filesystem of the scaffolder.
  *
  * @public
+ * @deprecated This action will be removed, prefer testing templates using the template editor instead.
  */
 export declare function createPublishFileAction(): TemplateAction<    {
 path: string;
@@ -513,6 +515,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -676,14 +680,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions
@@ -718,7 +722,7 @@ export declare type RunCommandOptions = {
  * @alpha
  * Registers the ScaffolderEntitiesProcessor with the catalog processing extension point.
  */
-export declare const scaffolderCatalogModule: (option: unknown) => BackendRegistrable;
+export declare const scaffolderCatalogModule: (options?: unknown) => BackendFeature;
 
 /** @public */
 export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {

package/dist/index.beta.d.ts

@@ -6,7 +6,7 @@
 
 /// <reference types="node" />
 
-import { BackendRegistrable } from '@backstage/backend-plugin-api';
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { CatalogApi } from '@backstage/catalog-client';
 import { CatalogProcessor } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
@@ -21,6 +21,7 @@ import { Knex } from 'knex';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { Observable } from '@backstage/types';
+import { Octokit } from 'octokit';
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { Schema } from 'jsonschema';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -418,6 +419,7 @@ token?: string | undefined;
  * production, as it writes the files to the local filesystem of the scaffolder.
  *
  * @public
+ * @deprecated This action will be removed, prefer testing templates using the template editor instead.
  */
 export declare function createPublishFileAction(): TemplateAction<    {
 path: string;
@@ -513,6 +515,8 @@ draft?: boolean | undefined;
 targetPath?: string | undefined;
 sourcePath?: string | undefined;
 token?: string | undefined;
+reviewers?: string[] | undefined;
+teamReviewers?: string[] | undefined;
 }>;
 
 /**
@@ -676,14 +680,14 @@ export declare function fetchContents({ reader, integrations, baseUrl, fetchUrl,
 }): Promise<void>;
 
 /** @public */
-export declare interface OctokitWithPullRequestPluginClient {
+export declare type OctokitWithPullRequestPluginClient = Octokit & {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
             number: number;
         };
     } | null>;
-}
+};
 
 /**
  * RouterOptions

package/dist/index.cjs.js

@@ -673,7 +673,7 @@ function createFetchTemplateAction(options) {
   });
 }
 function containsSkippedContent(localOutputPath) {
-  return localOutputPath === "" || path__default["default"].isAbsolute(localOutputPath) || localOutputPath.includes(`${path__default["default"].sep}${path__default["default"].sep}`);
+  return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
 const createFilesystemDeleteAction = () => {
@@ -2561,6 +2561,9 @@ function createPublishFileAction() {
       }
     },
     async handler(ctx) {
+      ctx.logger.warn(
+        "[DEPRECATED] This action will be removed, prefer testing templates using the template editor instead."
+      );
       const { path: path$1 } = ctx.input;
       const exists = await fs__default["default"].pathExists(path$1);
       if (exists) {
@@ -3055,6 +3058,22 @@ const createPublishGithubPullRequestAction = ({
             title: "Authentication Token",
             type: "string",
             description: "The token to use for authorization to GitHub"
+          },
+          reviewers: {
+            title: "Pull Request Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The users that will be added as reviewers to the pull request"
+          },
+          teamReviewers: {
+            title: "Pull Request Team Reviewers",
+            type: "array",
+            items: {
+              type: "string"
+            },
+            description: "The teams that will be added as reviewers to the pull request"
           }
         }
       },
@@ -3084,7 +3103,9 @@ const createPublishGithubPullRequestAction = ({
         draft,
         targetPath,
         sourcePath,
-        token: providedToken
+        token: providedToken,
+        reviewers,
+        teamReviewers
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -3132,13 +3153,46 @@ const createPublishGithubPullRequestAction = ({
         if (!response) {
           throw new GithubResponseError("null response from Github");
         }
+        const pullRequestNumber = response.data.number;
+        if (reviewers || teamReviewers) {
+          const pullRequest = { owner, repo, number: pullRequestNumber };
+          await requestReviewersOnPullRequest(
+            pullRequest,
+            reviewers,
+            teamReviewers,
+            client,
+            ctx.logger
+          );
+        }
         ctx.output("remoteUrl", response.data.html_url);
-        ctx.output("pullRequestNumber", response.data.number);
+        ctx.output("pullRequestNumber", pullRequestNumber);
       } catch (e) {
         throw new GithubResponseError("Pull request creation failed", e);
       }
     }
   });
+  async function requestReviewersOnPullRequest(pr, reviewers, teamReviewers, client, logger) {
+    var _a, _b, _c, _d;
+    try {
+      const result = await client.rest.pulls.requestReviewers({
+        owner: pr.owner,
+        repo: pr.repo,
+        pull_number: pr.number,
+        reviewers,
+        team_reviewers: teamReviewers
+      });
+      const addedUsers = (_b = (_a = result.data.requested_reviewers) == null ? void 0 : _a.join(", ")) != null ? _b : "";
+      const addedTeams = (_d = (_c = result.data.requested_teams) == null ? void 0 : _c.join(", ")) != null ? _d : "";
+      logger.info(
+        `Added users [${addedUsers}] and teams [${addedTeams}] as reviewers to Pull request ${pr.number}`
+      );
+    } catch (e) {
+      logger.error(
+        `Failure when adding reviewers to Pull request ${pr.number}`,
+        e
+      );
+    }
+  }
 };
 
 function createPublishGitlabAction(options) {
@@ -4455,7 +4509,10 @@ async function createRouter(options) {
     async (req, res) => {
       var _a, _b;
       const { namespace, kind, name } = req.params;
-      const { token } = parseBearerToken(req.headers.authorization);
+      const { token } = parseBearerToken({
+        header: req.headers.authorization,
+        logger
+      });
       const template = await findTemplate({
         catalogApi: catalogClient,
         entityRef: { kind, namespace, name },
@@ -4465,10 +4522,12 @@ async function createRouter(options) {
         const parameters = [(_a = template.spec.parameters) != null ? _a : []].flat();
         res.json({
           title: (_b = template.metadata.title) != null ? _b : template.metadata.name,
+          description: template.metadata.description,
           steps: parameters.map((schema) => {
             var _a2;
             return {
-              title: (_a2 = schema.title) != null ? _a2 : "Fill in template parameters",
+              title: (_a2 = schema.title) != null ? _a2 : "Please enter the following information",
+              description: schema.description,
               schema
             };
           })
@@ -4494,9 +4553,10 @@ async function createRouter(options) {
     const { kind, namespace, name } = catalogModel.parseEntityRef(templateRef, {
       defaultKind: "template"
     });
-    const { token, entityRef: userEntityRef } = parseBearerToken(
-      req.headers.authorization
-    );
+    const { token, entityRef: userEntityRef } = parseBearerToken({
+      header: req.headers.authorization,
+      logger
+    });
     const userEntity = userEntityRef ? await catalogClient.getEntityByRef(userEntityRef, { token }) : void 0;
     let auditLog = `Scaffolding task for ${templateRef}`;
     if (userEntityRef) {
@@ -4658,7 +4718,10 @@ data: ${JSON.stringify(event)}
     if (!await pluginScaffolderCommon.templateEntityV1beta3Validator.check(template)) {
       throw new errors.InputError("Input template is not a template");
     }
-    const { token } = parseBearerToken(req.headers.authorization);
+    const { token } = parseBearerToken({
+      header: req.headers.authorization,
+      logger
+    });
     for (const parameters of [(_a = template.spec.parameters) != null ? _a : []].flat()) {
       const result2 = jsonschema.validate(body.values, parameters);
       if (!result2.valid) {
@@ -4705,7 +4768,10 @@ data: ${JSON.stringify(event)}
   app.use("/", router);
   return app;
 }
-function parseBearerToken(header) {
+function parseBearerToken({
+  header,
+  logger
+}) {
   var _a;
   if (!header) {
     return {};
@@ -4726,9 +4792,11 @@ function parseBearerToken(header) {
     if (typeof sub !== "string") {
       throw new TypeError("Expected string sub claim");
     }
+    catalogModel.parseEntityRef(sub);
     return { entityRef: sub, token };
   } catch (e) {
-    throw new errors.InputError(`Invalid authorization header: ${errors.stringifyError(e)}`);
+    logger.error(`Invalid authorization header: ${errors.stringifyError(e)}`);
+    return {};
   }
 }
 
@@ -4791,12 +4859,10 @@ const scaffolderCatalogModule = backendPluginApi.createBackendModule({
   register(env) {
     env.registerInit({
       deps: {
-        catalogProcessingExtensionPoint: pluginCatalogNode.catalogProcessingExtentionPoint
+        catalog: pluginCatalogNode.catalogProcessingExtensionPoint
       },
-      async init({ catalogProcessingExtensionPoint }) {
-        catalogProcessingExtensionPoint.addProcessor(
-          new ScaffolderEntitiesProcessor()
-        );
+      async init({ catalog }) {
+        catalog.addProcessor(new ScaffolderEntitiesProcessor());
       }
     });
   }