@backstage/plugin-scaffolder-backend 1.3.0-next.2 → 1.4.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,79 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.4.0-next.1
+
+### Patch Changes
+
+- 801d606909: Improve error messaging when passing in malformed auth
+- Updated dependencies
+  - @backstage/catalog-model@1.1.0-next.1
+  - @backstage/backend-common@0.14.1-next.1
+  - @backstage/errors@1.1.0-next.0
+  - @backstage/plugin-catalog-backend@1.2.1-next.1
+  - @backstage/catalog-client@1.0.4-next.1
+  - @backstage/integration@1.2.2-next.1
+
+## 1.4.0-next.0
+
+### Minor Changes
+
+- 3500c13a33: Added a new `/v2/dry-run` endpoint that allows for a synchronous dry run of a provided template. A `supportsDryRun` option has been added to `createTemplateAction`, which signals whether the action should be executed during dry runs. When enabled, the action context will have the new `isDryRun` property set to signal if the action is being executed during a dry run.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.14.1-next.0
+  - @backstage/catalog-model@1.1.0-next.0
+  - @backstage/integration@1.2.2-next.0
+  - @backstage/plugin-catalog-backend@1.2.1-next.0
+  - @backstage/catalog-client@1.0.4-next.0
+  - @backstage/plugin-scaffolder-common@1.1.2-next.0
+
+## 1.3.0
+
+### Minor Changes
+
+- 35a26131b3: **DEPRECATION**: The `projectid` input parameters to the `publish:gitlab:merge-request`, it's no longer required as it can be decoded from the `repoUrl` input parameter.
+  **DEPRECATION**: The `projectid` output of the action in favour of `projectPath`
+- 72dfcbc8bf: A new scaffolder action has been added: `gerrit:publish`
+- ce0d8d7eb1: Fixed a bug in `publish:github` action that didn't permit to add users as collaborators.
+  This fix required changing the way parameters are passed to the action.
+  In order to add a team as collaborator, now you must use the `team` field instead of `username`.
+  In order to add a user as collaborator, you must use the `user` field.
+
+  It's still possible to use the field `username` but is deprecated in favor of `team`.
+
+  ```yaml
+  - id: publish
+    name: Publish
+    action: publish:github
+    input:
+      repoUrl: ...
+      collaborators:
+        - access: ...
+          team: my_team
+        - access: ...
+          user: my_username
+  ```
+
+- 582003a059: - Added an optional `list` method on the `TaskBroker` and `TaskStore` interface to list tasks by an optional `userEntityRef`
+  - Implemented a `list` method on the `DatabaseTaskStore` class to list tasks by an optional `userEntityRef`
+  - Added a route under `/v2/tasks` to list tasks by a `userEntityRef` using the `createdBy` query parameter
+- c042c5eaff: Add an option to not protect the default branch.
+- f93af969cd: Added the ability to support running of templates that are not in the `default` namespace
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- 6901f6be4a: Adds more of an explanation when the `publish:github` scaffolder action fails to create a repository.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.2.0
+  - @backstage/backend-common@0.14.0
+  - @backstage/integration@1.2.1
+  - @backstage/catalog-client@1.0.3
+  - @backstage/catalog-model@1.0.3
+  - @backstage/plugin-scaffolder-common@1.1.1
+
 ## 1.3.0-next.2
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -2416,7 +2416,7 @@ const createPublishGitlabMergeRequestAction = (options) => {
     id: "publish:gitlab:merge-request",
     schema: {
       input: {
-        required: ["projectid", "repoUrl", "targetPath", "branchName"],
+        required: ["repoUrl", "targetPath", "branchName"],
         type: "object",
         properties: {
           repoUrl: {
@@ -2463,6 +2463,10 @@ const createPublishGitlabMergeRequestAction = (options) => {
             title: "Gitlab Project id/Name(slug)",
             type: "string"
           },
+          projectPath: {
+            title: "Gitlab Project path",
+            type: "string"
+          },
           mergeRequestURL: {
             title: "MergeRequest(MR) URL",
             type: "string",
@@ -2474,7 +2478,13 @@ const createPublishGitlabMergeRequestAction = (options) => {
     async handler(ctx) {
       var _a;
       const repoUrl = ctx.input.repoUrl;
-      const { host } = parseRepoUrl(repoUrl, integrations);
+      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);
+      const projectPath = `${owner}/${repo}`;
+      if (ctx.input.projectid) {
+        const deprecationWarning = `Property "projectid" is deprecated and no longer to needed to create a MR`;
+        ctx.logger.warn(deprecationWarning);
+        console.warn(deprecationWarning);
+      }
       const integrationConfig = integrations.gitlab.byHost(host);
       const destinationBranch = ctx.input.branchName;
       if (!integrationConfig) {
@@ -2500,23 +2510,24 @@ const createPublishGitlabMergeRequestAction = (options) => {
         content: file.content.toString("base64"),
         execute_filemode: file.executable
       }));
-      const projects = await api.Projects.show(ctx.input.projectid);
+      const projects = await api.Projects.show(projectPath);
       const { default_branch: defaultBranch } = projects;
       try {
-        await api.Branches.create(ctx.input.projectid, destinationBranch, String(defaultBranch));
+        await api.Branches.create(projectPath, destinationBranch, String(defaultBranch));
       } catch (e) {
         throw new errors.InputError(`The branch creation failed ${e}`);
       }
       try {
-        await api.Commits.create(ctx.input.projectid, destinationBranch, ctx.input.title, actions);
+        await api.Commits.create(projectPath, destinationBranch, ctx.input.title, actions);
       } catch (e) {
         throw new errors.InputError(`Committing the changes to ${destinationBranch} failed ${e}`);
       }
       try {
-        const mergeRequestUrl = await api.MergeRequests.create(ctx.input.projectid, destinationBranch, String(defaultBranch), ctx.input.title, { description: ctx.input.description }).then((mergeRequest) => {
+        const mergeRequestUrl = await api.MergeRequests.create(projectPath, destinationBranch, String(defaultBranch), ctx.input.title, { description: ctx.input.description }).then((mergeRequest) => {
           return mergeRequest.web_url;
         });
-        ctx.output("projectid", ctx.input.projectid);
+        ctx.output("projectid", projectPath);
+        ctx.output("projectPath", projectPath);
         ctx.output("mergeRequestUrl", mergeRequestUrl);
       } catch (e) {
         throw new errors.InputError(`Merge request creation failed${e}`);
@@ -3590,9 +3601,6 @@ function getEntityBaseUrl(entity) {
 }
 async function findTemplate(options) {
   const { entityRef, token, catalogApi } = options;
-  if (entityRef.namespace.toLocaleLowerCase("en-US") !== catalogModel.DEFAULT_NAMESPACE) {
-    throw new errors.InputError(`Invalid namespace, only '${catalogModel.DEFAULT_NAMESPACE}' namespace is supported`);
-  }
   if (entityRef.kind.toLocaleLowerCase("en-US") !== "template") {
     throw new errors.InputError(`Invalid kind, only 'Template' kind is supported`);
   }
@@ -3890,15 +3898,27 @@ data: ${JSON.stringify(event)}
 }
 function parseBearerToken(header) {
   var _a;
-  const token = (_a = header == null ? void 0 : header.match(/Bearer\s+(\S+)/i)) == null ? void 0 : _a[1];
-  if (!token)
+  if (!header) {
     return {};
-  const [_header, rawPayload, _signature] = token.split(".");
-  const payload = JSON.parse(Buffer.from(rawPayload, "base64").toString());
-  return {
-    entityRef: payload.sub,
-    token
-  };
+  }
+  try {
+    const token = (_a = header.match(/^Bearer\s(\S+\.\S+\.\S+)$/i)) == null ? void 0 : _a[1];
+    if (!token) {
+      throw new TypeError("Expected Bearer with JWT");
+    }
+    const [_header, rawPayload, _signature] = token.split(".");
+    const payload = JSON.parse(Buffer.from(rawPayload, "base64").toString());
+    if (typeof payload !== "object" || payload === null || Array.isArray(payload)) {
+      throw new TypeError("Malformed JWT payload");
+    }
+    const sub = payload.sub;
+    if (typeof sub !== "string") {
+      throw new TypeError("Expected string sub claim");
+    }
+    return { entityRef: sub, token };
+  } catch (e) {
+    throw new errors.InputError(`Invalid authorization header: ${errors.stringifyError(e)}`);
+  }
 }
 
 class ScaffolderEntitiesProcessor {