@backstage/plugin-scaffolder-backend 0.15.16 → 0.15.17

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-scaffolder-backend
 
+## 0.15.17
+
+### Patch Changes
+
+- eec0750d8d: Makes cookiecutter a default, but optional action based on if a containerRunner argument is passed in to createRouter or createBuiltinActions
+- ed52f74ab3: Adding changes to create GitLab Merge Request using custom action
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.19.2
+  - @backstage/backend-common@0.9.14
+  - @backstage/catalog-model@0.9.8
+
 ## 0.15.16
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1622,6 +1622,120 @@ function createPublishGitlabAction(options) {
   });
 }
 
+const createPublishGitlabMergeRequestAction = (options) => {
+  const { integrations } = options;
+  return createTemplateAction({
+    id: "publish:gitlab:merge-request",
+    schema: {
+      input: {
+        required: ["projectid", "repoUrl", "targetPath", "branchName"],
+        type: "object",
+        properties: {
+          repoUrl: {
+            type: "string",
+            title: "Repository Location",
+            description: `Accepts the format 'gitlab.com/group_name/project_name' where 'project_name' is the repository name and 'group_name' is a group or username`
+          },
+          projectid: {
+            type: "string",
+            title: "projectid",
+            description: "Project ID/Name(slug) of the Gitlab Project"
+          },
+          title: {
+            type: "string",
+            title: "Merge Request Name",
+            description: "The name for the merge request"
+          },
+          description: {
+            type: "string",
+            title: "Merge Request Description",
+            description: "The description of the merge request"
+          },
+          branchName: {
+            type: "string",
+            title: "Destination Branch name",
+            description: "The description of the merge request"
+          },
+          targetPath: {
+            type: "string",
+            title: "Repository Subdirectory",
+            description: "Subdirectory of repository to apply changes to"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          projectid: {
+            title: "Gitlab Project id/Name(slug)",
+            type: "string"
+          },
+          mergeRequestURL: {
+            title: "MergeRequest(MR) URL",
+            type: "string",
+            description: "Link to the merge request in GitLab"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const repoUrl = ctx.input.repoUrl;
+      const { host } = parseRepoUrl(repoUrl, integrations);
+      const integrationConfig = integrations.gitlab.byHost(host);
+      const actions = [];
+      const destinationBranch = ctx.input.branchName;
+      if (!integrationConfig) {
+        throw new errors.InputError(`No matching integration configuration for host ${host}, please check your integrations config`);
+      }
+      if (!integrationConfig.config.token) {
+        throw new errors.InputError(`No token available for host ${host}`);
+      }
+      const api = new node.Gitlab({
+        host: integrationConfig.config.baseUrl,
+        token: integrationConfig.config.token
+      });
+      const fileRoot = ctx.workspacePath;
+      const localFilePaths = await globby__default["default"]([`${ctx.input.targetPath}/**`], {
+        cwd: fileRoot,
+        gitignore: true,
+        dot: true
+      });
+      const fileContents = await Promise.all(localFilePaths.map((p) => fs.readFile(backendCommon.resolveSafeChildPath(fileRoot, p))));
+      const repoFilePaths = localFilePaths.map((repoFilePath) => {
+        return repoFilePath;
+      });
+      for (let i = 0; i < repoFilePaths.length; i++) {
+        actions.push({
+          action: "create",
+          filePath: repoFilePaths[i],
+          content: fileContents[i].toString()
+        });
+      }
+      const projects = await api.Projects.show(ctx.input.projectid);
+      const { default_branch: defaultBranch } = projects;
+      try {
+        await api.Branches.create(ctx.input.projectid, 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);
+      } 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) => {
+          return mergeRequest.web_url;
+        });
+        ctx.output("projectid", ctx.input.projectid);
+        ctx.output("mergeRequestUrl", mergeRequestUrl);
+      } catch (e) {
+        throw new errors.InputError(`Merge request creation failed${e}`);
+      }
+    }
+  });
+};
+
 function createGithubActionsDispatchAction(options) {
   const { integrations } = options;
   const octokitProvider = new OctokitProvider(integrations);
@@ -1768,16 +1882,11 @@ function createGithubWebhookAction(options) {
 
 const createBuiltinActions = (options) => {
   const { reader, integrations, containerRunner, catalogClient, config } = options;
-  return [
+  const actions = [
     createFetchPlainAction({
       reader,
       integrations
     }),
-    pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
-      reader,
-      integrations,
-      containerRunner
-    }),
     createFetchTemplateAction({
       integrations,
       reader
@@ -1793,6 +1902,9 @@ const createBuiltinActions = (options) => {
       integrations,
       config
     }),
+    createPublishGitlabMergeRequestAction({
+      integrations
+    }),
     createPublishBitbucketAction({
       integrations,
       config
@@ -1813,6 +1925,14 @@ const createBuiltinActions = (options) => {
       integrations
     })
   ];
+  if (containerRunner) {
+    actions.push(pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
+      reader,
+      integrations,
+      containerRunner
+    }));
+  }
+  return actions;
 };
 
 class TemplateActionRegistry {
@@ -2875,6 +2995,7 @@ exports.createPublishFileAction = createPublishFileAction;
 exports.createPublishGithubAction = createPublishGithubAction;
 exports.createPublishGithubPullRequestAction = createPublishGithubPullRequestAction;
 exports.createPublishGitlabAction = createPublishGitlabAction;
+exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
 exports.createRouter = createRouter;
 exports.createTemplateAction = createTemplateAction;
 exports.fetchContents = fetchContents;