@backstage/plugin-scaffolder-backend 1.8.0-next.0 → 1.8.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.8.0-next.1
+
+### Minor Changes
+
+- 5921b5ce49: - The GitLab Project ID for the `publish:gitlab:merge-request` action is now passed through the query parameter `project` in the `repoUrl`. It still allows people to not use the `projectid` and use the `repoUrl` with the `owner` and `repo` query parameters instead. This makes it easier to publish to repositories instead of writing the full path to the project.
+
 ## 1.8.0-next.0
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -565,7 +565,7 @@ sourcePath?: string | undefined;
 targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
-/** @deprecated Use projectPath instead */
+/** @deprecated projectID passed as query parameters in the repoUrl */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
 assignee?: string | undefined;

package/dist/index.beta.d.ts

@@ -565,7 +565,7 @@ sourcePath?: string | undefined;
 targetPath?: string | undefined;
 token?: string | undefined;
 commitAction?: "update" | "create" | "delete" | undefined;
-/** @deprecated Use projectPath instead */
+/** @deprecated projectID passed as query parameters in the repoUrl */
 projectid?: string | undefined;
 removeSourceBranch?: boolean | undefined;
 assignee?: string | undefined;

package/dist/index.cjs.js

@@ -851,34 +851,41 @@ const parseRepoUrl = (repoUrl, integrations) => {
       `No matching integration configuration for host ${host}, please check your integrations config`
     );
   }
-  if (type === "bitbucket") {
-    if (host === "bitbucket.org") {
-      if (!workspace) {
-        throw new errors.InputError(
-          `Invalid repo URL passed to publisher: ${repoUrl}, missing workspace`
-        );
+  const repo = parsed.searchParams.get("repo");
+  switch (type) {
+    case "bitbucket": {
+      if (host === "www.bitbucket.org") {
+        checkRequiredParams(parsed, "workspace");
       }
+      checkRequiredParams(parsed, "project", "repo");
+      break;
     }
-    if (!project) {
-      throw new errors.InputError(
-        `Invalid repo URL passed to publisher: ${repoUrl}, missing project`
-      );
+    case "gitlab": {
+      if (!project) {
+        checkRequiredParams(parsed, "owner", "repo");
+      }
+      break;
     }
-  } else {
-    if (!owner && type !== "gerrit") {
-      throw new errors.InputError(
-        `Invalid repo URL passed to publisher: ${repoUrl}, missing owner`
-      );
+    case "gerrit": {
+      checkRequiredParams(parsed, "repo");
+      break;
+    }
+    default: {
+      checkRequiredParams(parsed, "repo", "owner");
+      break;
     }
-  }
-  const repo = parsed.searchParams.get("repo");
-  if (!repo) {
-    throw new errors.InputError(
-      `Invalid repo URL passed to publisher: ${repoUrl}, missing repo`
-    );
   }
   return { host, owner, repo, organization, workspace, project };
 };
+function checkRequiredParams(repoUrl, ...params) {
+  for (let i = 0; i < params.length; i++) {
+    if (!repoUrl.searchParams.get(params[i])) {
+      throw new errors.InputError(
+        `Invalid repo URL passed to publisher: ${repoUrl.toString()}, missing ${params[i]}`
+      );
+    }
+  }
+}
 
 const executeShellCommand = async (options) => {
   const {
@@ -3525,13 +3532,11 @@ const createPublishGitlabMergeRequestAction = (options) => {
         title,
         token: providedToken
       } = ctx.input;
-      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 { host, owner, repo, project } = parseRepoUrl(
+        repoUrl,
+        integrations
+      );
+      const repoID = project ? project : `${owner}/${repo}`;
       const integrationConfig = integrations.gitlab.byHost(host);
       if (!integrationConfig) {
         throw new errors.InputError(
@@ -3579,19 +3584,15 @@ const createPublishGitlabMergeRequestAction = (options) => {
           execute_filemode: file.executable
         };
       });
-      const projects = await api.Projects.show(projectPath);
+      const projects = await api.Projects.show(repoID);
       const { default_branch: defaultBranch } = projects;
       try {
-        await api.Branches.create(
-          projectPath,
-          branchName,
-          String(defaultBranch)
-        );
+        await api.Branches.create(repoID, branchName, String(defaultBranch));
       } catch (e) {
         throw new errors.InputError(`The branch creation failed ${e}`);
       }
       try {
-        await api.Commits.create(projectPath, branchName, title, actions);
+        await api.Commits.create(repoID, branchName, ctx.input.title, actions);
       } catch (e) {
         throw new errors.InputError(
           `Committing the changes to ${branchName} failed ${e}`
@@ -3599,7 +3600,7 @@ const createPublishGitlabMergeRequestAction = (options) => {
       }
       try {
         const mergeRequestUrl = await api.MergeRequests.create(
-          projectPath,
+          repoID,
           branchName,
           String(defaultBranch),
           title,
@@ -3611,8 +3612,8 @@ const createPublishGitlabMergeRequestAction = (options) => {
         ).then((mergeRequest) => {
           return mergeRequest.web_url;
         });
-        ctx.output("projectid", projectPath);
-        ctx.output("projectPath", projectPath);
+        ctx.output("projectid", repoID);
+        ctx.output("projectPath", repoID);
         ctx.output("mergeRequestUrl", mergeRequestUrl);
       } catch (e) {
         throw new errors.InputError(`Merge request creation failed${e}`);