@backstage/plugin-scaffolder-backend-module-gitlab 0.5.1-next.0 → 0.6.0-next.2

package/dist/actions/gitlabMergeRequest.cjs.js

@@ -0,0 +1,231 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var path = require('path');
+var errors = require('@backstage/errors');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var helpers = require('./helpers.cjs.js');
+var gitlabMergeRequest_examples = require('./gitlabMergeRequest.examples.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+
+function getFileAction(fileInfo, remoteFiles, defaultCommitAction) {
+  if (!defaultCommitAction || defaultCommitAction === "auto") {
+    const filePath = path__default.default.join(fileInfo.targetPath ?? "", fileInfo.file.path);
+    return remoteFiles && remoteFiles.some((remoteFile) => remoteFile.path === filePath) ? "update" : "create";
+  }
+  return defaultCommitAction;
+}
+const createPublishGitlabMergeRequestAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "publish:gitlab:merge-request",
+    examples: gitlabMergeRequest_examples.examples,
+    schema: {
+      input: {
+        required: ["repoUrl", "branchName"],
+        type: "object",
+        properties: {
+          repoUrl: {
+            type: "string",
+            title: "Repository Location",
+            description: `Accepts the format 'gitlab.com?repo=project_name&owner=group_name' where 'project_name' is the repository name and 'group_name' is a group or username`
+          },
+          /** @deprecated projectID is passed as query parameters in the repoUrl */
+          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: "Source Branch Name",
+            description: "The source branch name of the merge request"
+          },
+          targetBranchName: {
+            type: "string",
+            title: "Target Branch Name",
+            description: "The target branch name of the merge request"
+          },
+          sourcePath: {
+            type: "string",
+            title: "Working Subdirectory",
+            description: "Subdirectory of working directory to copy changes from"
+          },
+          targetPath: {
+            type: "string",
+            title: "Repository Subdirectory",
+            description: "Subdirectory of repository to apply changes to"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The token to use for authorization to GitLab"
+          },
+          commitAction: {
+            title: "Commit action",
+            type: "string",
+            enum: ["create", "update", "delete", "auto"],
+            description: 'The action to be used for git commit. Defaults to auto. "auto" is custom action provide by backstage, (automatic assign create or update action) /!\\ Use more api calls /!\\ *'
+          },
+          removeSourceBranch: {
+            title: "Delete source branch",
+            type: "boolean",
+            description: "Option to delete source branch once the MR has been merged. Default: false"
+          },
+          assignee: {
+            title: "Merge Request Assignee",
+            type: "string",
+            description: "User this merge request will be assigned to"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          targetBranchName: {
+            title: "Target branch name of the merge request",
+            type: "string"
+          },
+          projectid: {
+            title: "Gitlab Project id/Name(slug)",
+            type: "string"
+          },
+          projectPath: {
+            title: "Gitlab Project path",
+            type: "string"
+          },
+          mergeRequestUrl: {
+            title: "MergeRequest(MR) URL",
+            type: "string",
+            description: "Link to the merge request in GitLab"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        assignee,
+        branchName,
+        targetBranchName,
+        description,
+        repoUrl,
+        removeSourceBranch,
+        targetPath,
+        sourcePath,
+        title,
+        token
+      } = ctx.input;
+      const { owner, repo, project } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
+      const repoID = project ? project : `${owner}/${repo}`;
+      const api = helpers.createGitlabApi({
+        integrations,
+        token,
+        repoUrl
+      });
+      let assigneeId = void 0;
+      if (assignee !== void 0) {
+        try {
+          const assigneeUser = await api.Users.username(assignee);
+          assigneeId = assigneeUser[0].id;
+        } catch (e) {
+          ctx.logger.warn(
+            `Failed to find gitlab user id for ${assignee}: ${e}. Proceeding with MR creation without an assignee.`
+          );
+        }
+      }
+      let fileRoot;
+      if (sourcePath) {
+        fileRoot = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, sourcePath);
+      } else if (targetPath) {
+        fileRoot = backendPluginApi.resolveSafeChildPath(ctx.workspacePath, targetPath);
+      } else {
+        fileRoot = ctx.workspacePath;
+      }
+      const fileContents = await pluginScaffolderNode.serializeDirectoryContents(fileRoot, {
+        gitignore: true
+      });
+      let targetBranch = targetBranchName;
+      if (!targetBranch) {
+        const projects = await api.Projects.show(repoID);
+        const { default_branch: defaultBranch } = projects;
+        targetBranch = defaultBranch;
+      }
+      let remoteFiles = [];
+      if (!ctx.input.commitAction || ctx.input.commitAction === "auto") {
+        try {
+          remoteFiles = await api.Repositories.tree(repoID, {
+            ref: targetBranch,
+            recursive: true,
+            path: targetPath ?? void 0
+          });
+        } catch (e) {
+          ctx.logger.warn(
+            `Could not retrieve the list of files for ${repoID} (branch: ${targetBranch}) : ${e}`
+          );
+        }
+      }
+      const actions = fileContents.map((file) => ({
+        action: getFileAction(
+          { file, targetPath },
+          remoteFiles,
+          ctx.input.commitAction
+        ),
+        filePath: targetPath ? path__default.default.posix.join(targetPath, file.path) : file.path,
+        encoding: "base64",
+        content: file.content.toString("base64"),
+        execute_filemode: file.executable
+      }));
+      try {
+        await api.Branches.create(repoID, branchName, String(targetBranch));
+      } catch (e) {
+        throw new errors.InputError(
+          `The branch creation failed. Please check that your repo does not already contain a branch named '${branchName}'. ${e}`
+        );
+      }
+      try {
+        await api.Commits.create(repoID, branchName, ctx.input.title, actions);
+      } catch (e) {
+        throw new errors.InputError(
+          `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${e}`
+        );
+      }
+      try {
+        const mergeRequestUrl = await api.MergeRequests.create(
+          repoID,
+          branchName,
+          String(targetBranch),
+          title,
+          {
+            description,
+            removeSourceBranch: removeSourceBranch ? removeSourceBranch : false,
+            assigneeId
+          }
+        ).then((mergeRequest) => {
+          return mergeRequest.web_url;
+        });
+        ctx.output("projectid", repoID);
+        ctx.output("targetBranchName", targetBranch);
+        ctx.output("projectPath", repoID);
+        ctx.output("mergeRequestUrl", mergeRequestUrl);
+      } catch (e) {
+        throw new errors.InputError(`Merge request creation failed${e}`);
+      }
+    }
+  });
+};
+
+exports.createPublishGitlabMergeRequestAction = createPublishGitlabMergeRequestAction;
+//# sourceMappingURL=gitlabMergeRequest.cjs.js.map

package/dist/actions/gitlabMergeRequest.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabMergeRequest.cjs.js","sources":["../../src/actions/gitlabMergeRequest.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  SerializedFile,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { Types } from '@gitbeaker/core';\nimport path from 'path';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { InputError } from '@backstage/errors';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { createGitlabApi } from './helpers';\nimport { examples } from './gitlabMergeRequest.examples';\n\nfunction getFileAction(\n  fileInfo: { file: SerializedFile; targetPath: string | undefined },\n  remoteFiles: Types.RepositoryTreeSchema[],\n  defaultCommitAction: 'create' | 'delete' | 'update' | 'auto' | undefined,\n): 'create' | 'delete' | 'update' {\n  if (!defaultCommitAction || defaultCommitAction === 'auto') {\n    const filePath = path.join(fileInfo.targetPath ?? '', fileInfo.file.path);\n    return remoteFiles &&\n      remoteFiles.some(remoteFile => remoteFile.path === filePath)\n      ? 'update'\n      : 'create';\n  }\n  return defaultCommitAction;\n}\n\n/**\n * Create a new action that creates a gitlab merge request.\n *\n * @public\n */\nexport const createPublishGitlabMergeRequestAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n\n  return createTemplateAction<{\n    repoUrl: string;\n    title: string;\n    description: string;\n    branchName: string;\n    targetBranchName?: string;\n    sourcePath?: string;\n    targetPath?: string;\n    token?: string;\n    commitAction?: 'create' | 'delete' | 'update' | 'auto';\n    /** @deprecated projectID passed as query parameters in the repoUrl */\n    projectid?: string;\n    removeSourceBranch?: boolean;\n    assignee?: string;\n  }>({\n    id: 'publish:gitlab:merge-request',\n    examples,\n    schema: {\n      input: {\n        required: ['repoUrl', 'branchName'],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            type: 'string',\n            title: 'Repository Location',\n            description: `Accepts the format 'gitlab.com?repo=project_name&owner=group_name' where 'project_name' is the repository name and 'group_name' is a group or username`,\n          },\n          /** @deprecated projectID is passed as query parameters in the repoUrl */\n          projectid: {\n            type: 'string',\n            title: 'projectid',\n            description: 'Project ID/Name(slug) of the Gitlab Project',\n          },\n          title: {\n            type: 'string',\n            title: 'Merge Request Name',\n            description: 'The name for the merge request',\n          },\n          description: {\n            type: 'string',\n            title: 'Merge Request Description',\n            description: 'The description of the merge request',\n          },\n          branchName: {\n            type: 'string',\n            title: 'Source Branch Name',\n            description: 'The source branch name of the merge request',\n          },\n          targetBranchName: {\n            type: 'string',\n            title: 'Target Branch Name',\n            description: 'The target branch name of the merge request',\n          },\n          sourcePath: {\n            type: 'string',\n            title: 'Working Subdirectory',\n            description:\n              'Subdirectory of working directory to copy changes from',\n          },\n          targetPath: {\n            type: 'string',\n            title: 'Repository Subdirectory',\n            description: 'Subdirectory of repository to apply changes to',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitLab',\n          },\n          commitAction: {\n            title: 'Commit action',\n            type: 'string',\n            enum: ['create', 'update', 'delete', 'auto'],\n            description:\n              'The action to be used for git commit. Defaults to auto. \"auto\" is custom action provide by backstage, (automatic assign create or update action) /!\\\\ Use more api calls /!\\\\ *',\n          },\n          removeSourceBranch: {\n            title: 'Delete source branch',\n            type: 'boolean',\n            description:\n              'Option to delete source branch once the MR has been merged. Default: false',\n          },\n          assignee: {\n            title: 'Merge Request Assignee',\n            type: 'string',\n            description: 'User this merge request will be assigned to',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          targetBranchName: {\n            title: 'Target branch name of the merge request',\n            type: 'string',\n          },\n          projectid: {\n            title: 'Gitlab Project id/Name(slug)',\n            type: 'string',\n          },\n          projectPath: {\n            title: 'Gitlab Project path',\n            type: 'string',\n          },\n          mergeRequestUrl: {\n            title: 'MergeRequest(MR) URL',\n            type: 'string',\n            description: 'Link to the merge request in GitLab',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        assignee,\n        branchName,\n        targetBranchName,\n        description,\n        repoUrl,\n        removeSourceBranch,\n        targetPath,\n        sourcePath,\n        title,\n        token,\n      } = ctx.input;\n\n      const { owner, repo, project } = parseRepoUrl(repoUrl, integrations);\n      const repoID = project ? project : `${owner}/${repo}`;\n\n      const api = createGitlabApi({\n        integrations,\n        token,\n        repoUrl,\n      });\n\n      let assigneeId = undefined;\n\n      if (assignee !== undefined) {\n        try {\n          const assigneeUser = await api.Users.username(assignee);\n          assigneeId = assigneeUser[0].id;\n        } catch (e) {\n          ctx.logger.warn(\n            `Failed to find gitlab user id for ${assignee}: ${e}. Proceeding with MR creation without an assignee.`,\n          );\n        }\n      }\n\n      let fileRoot: string;\n      if (sourcePath) {\n        fileRoot = resolveSafeChildPath(ctx.workspacePath, sourcePath);\n      } else if (targetPath) {\n        // for backward compatibility\n        fileRoot = resolveSafeChildPath(ctx.workspacePath, targetPath);\n      } else {\n        fileRoot = ctx.workspacePath;\n      }\n\n      const fileContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      let targetBranch = targetBranchName;\n      if (!targetBranch) {\n        const projects = await api.Projects.show(repoID);\n\n        const { default_branch: defaultBranch } = projects;\n        targetBranch = defaultBranch!;\n      }\n\n      let remoteFiles: Types.RepositoryTreeSchema[] = [];\n      if (!ctx.input.commitAction || ctx.input.commitAction === 'auto') {\n        try {\n          remoteFiles = await api.Repositories.tree(repoID, {\n            ref: targetBranch,\n            recursive: true,\n            path: targetPath ?? undefined,\n          });\n        } catch (e) {\n          ctx.logger.warn(\n            `Could not retrieve the list of files for ${repoID} (branch: ${targetBranch}) : ${e}`,\n          );\n        }\n      }\n\n      const actions: Types.CommitAction[] = fileContents.map(file => ({\n        action: getFileAction(\n          { file, targetPath },\n          remoteFiles,\n          ctx.input.commitAction,\n        ),\n        filePath: targetPath\n          ? path.posix.join(targetPath, file.path)\n          : file.path,\n        encoding: 'base64',\n        content: file.content.toString('base64'),\n        execute_filemode: file.executable,\n      }));\n\n      try {\n        await api.Branches.create(repoID, branchName, String(targetBranch));\n      } catch (e) {\n        throw new InputError(\n          `The branch creation failed. Please check that your repo does not already contain a branch named '${branchName}'. ${e}`,\n        );\n      }\n\n      try {\n        await api.Commits.create(repoID, branchName, ctx.input.title, actions);\n      } catch (e) {\n        throw new InputError(\n          `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${e}`,\n        );\n      }\n\n      try {\n        const mergeRequestUrl = await api.MergeRequests.create(\n          repoID,\n          branchName,\n          String(targetBranch),\n          title,\n          {\n            description,\n            removeSourceBranch: removeSourceBranch ? removeSourceBranch : false,\n            assigneeId,\n          },\n        ).then((mergeRequest: { web_url: string }) => {\n          return mergeRequest.web_url;\n        });\n        ctx.output('projectid', repoID);\n        ctx.output('targetBranchName', targetBranch);\n        ctx.output('projectPath', repoID);\n        ctx.output('mergeRequestUrl', mergeRequestUrl);\n      } catch (e) {\n        throw new InputError(`Merge request creation failed${e}`);\n      }\n    },\n  });\n};\n"],"names":["path","createTemplateAction","examples","parseRepoUrl","createGitlabApi","resolveSafeChildPath","serializeDirectoryContents","InputError"],"mappings":";;;;;;;;;;;;;AA8BA,SAAS,aAAA,CACP,QACA,EAAA,WAAA,EACA,mBACgC,EAAA;AAChC,EAAI,IAAA,CAAC,mBAAuB,IAAA,mBAAA,KAAwB,MAAQ,EAAA;AAC1D,IAAM,MAAA,QAAA,GAAWA,sBAAK,IAAK,CAAA,QAAA,CAAS,cAAc,EAAI,EAAA,QAAA,CAAS,KAAK,IAAI,CAAA,CAAA;AACxE,IAAO,OAAA,WAAA,IACL,YAAY,IAAK,CAAA,CAAA,UAAA,KAAc,WAAW,IAAS,KAAA,QAAQ,IACzD,QACA,GAAA,QAAA,CAAA;AAAA,GACN;AACA,EAAO,OAAA,mBAAA,CAAA;AACT,CAAA;AAOa,MAAA,qCAAA,GAAwC,CAAC,OAEhD,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AAEzB,EAAA,OAAOC,yCAcJ,CAAA;AAAA,IACD,EAAI,EAAA,8BAAA;AAAA,cACJC,oCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAA,EAAU,CAAC,SAAA,EAAW,YAAY,CAAA;AAAA,QAClC,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,qBAAA;AAAA,YACP,WAAa,EAAA,CAAA,sJAAA,CAAA;AAAA,WACf;AAAA;AAAA,UAEA,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,WAAA;AAAA,YACP,WAAa,EAAA,6CAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA,gCAAA;AAAA,WACf;AAAA,UACA,WAAa,EAAA;AAAA,YACX,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,2BAAA;AAAA,YACP,WAAa,EAAA,sCAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA,6CAAA;AAAA,WACf;AAAA,UACA,gBAAkB,EAAA;AAAA,YAChB,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,oBAAA;AAAA,YACP,WAAa,EAAA,6CAAA;AAAA,WACf;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,sBAAA;AAAA,YACP,WACE,EAAA,wDAAA;AAAA,WACJ;AAAA,UACA,UAAY,EAAA;AAAA,YACV,IAAM,EAAA,QAAA;AAAA,YACN,KAAO,EAAA,yBAAA;AAAA,YACP,WAAa,EAAA,gDAAA;AAAA,WACf;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,8CAAA;AAAA,WACf;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,eAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,IAAM,EAAA,CAAC,QAAU,EAAA,QAAA,EAAU,UAAU,MAAM,CAAA;AAAA,YAC3C,WACE,EAAA,iLAAA;AAAA,WACJ;AAAA,UACA,kBAAoB,EAAA;AAAA,YAClB,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,WACE,EAAA,4EAAA;AAAA,WACJ;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,wBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,6CAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,gBAAkB,EAAA;AAAA,YAChB,KAAO,EAAA,yCAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,8BAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,eAAiB,EAAA;AAAA,YACf,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,qCAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,QAAA;AAAA,QACA,UAAA;AAAA,QACA,gBAAA;AAAA,QACA,WAAA;AAAA,QACA,OAAA;AAAA,QACA,kBAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA;AAAA,QACA,KAAA;AAAA,UACE,GAAI,CAAA,KAAA,CAAA;AAER,MAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAM,SAAY,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AACnE,MAAA,MAAM,SAAS,OAAU,GAAA,OAAA,GAAU,CAAG,EAAA,KAAK,IAAI,IAAI,CAAA,CAAA,CAAA;AAEnD,MAAA,MAAM,MAAMC,uBAAgB,CAAA;AAAA,QAC1B,YAAA;AAAA,QACA,KAAA;AAAA,QACA,OAAA;AAAA,OACD,CAAA,CAAA;AAED,MAAA,IAAI,UAAa,GAAA,KAAA,CAAA,CAAA;AAEjB,MAAA,IAAI,aAAa,KAAW,CAAA,EAAA;AAC1B,QAAI,IAAA;AACF,UAAA,MAAM,YAAe,GAAA,MAAM,GAAI,CAAA,KAAA,CAAM,SAAS,QAAQ,CAAA,CAAA;AACtD,UAAa,UAAA,GAAA,YAAA,CAAa,CAAC,CAAE,CAAA,EAAA,CAAA;AAAA,iBACtB,CAAG,EAAA;AACV,UAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,YACT,CAAA,kCAAA,EAAqC,QAAQ,CAAA,EAAA,EAAK,CAAC,CAAA,kDAAA,CAAA;AAAA,WACrD,CAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAI,IAAA,QAAA,CAAA;AACJ,MAAA,IAAI,UAAY,EAAA;AACd,QAAW,QAAA,GAAAC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA,CAAA;AAAA,iBACpD,UAAY,EAAA;AAErB,QAAW,QAAA,GAAAA,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA,CAAA;AAAA,OACxD,MAAA;AACL,QAAA,QAAA,GAAW,GAAI,CAAA,aAAA,CAAA;AAAA,OACjB;AAEA,MAAM,MAAA,YAAA,GAAe,MAAMC,+CAAA,CAA2B,QAAU,EAAA;AAAA,QAC9D,SAAW,EAAA,IAAA;AAAA,OACZ,CAAA,CAAA;AAED,MAAA,IAAI,YAAe,GAAA,gBAAA,CAAA;AACnB,MAAA,IAAI,CAAC,YAAc,EAAA;AACjB,QAAA,MAAM,QAAW,GAAA,MAAM,GAAI,CAAA,QAAA,CAAS,KAAK,MAAM,CAAA,CAAA;AAE/C,QAAM,MAAA,EAAE,cAAgB,EAAA,aAAA,EAAkB,GAAA,QAAA,CAAA;AAC1C,QAAe,YAAA,GAAA,aAAA,CAAA;AAAA,OACjB;AAEA,MAAA,IAAI,cAA4C,EAAC,CAAA;AACjD,MAAA,IAAI,CAAC,GAAI,CAAA,KAAA,CAAM,gBAAgB,GAAI,CAAA,KAAA,CAAM,iBAAiB,MAAQ,EAAA;AAChE,QAAI,IAAA;AACF,UAAA,WAAA,GAAc,MAAM,GAAA,CAAI,YAAa,CAAA,IAAA,CAAK,MAAQ,EAAA;AAAA,YAChD,GAAK,EAAA,YAAA;AAAA,YACL,SAAW,EAAA,IAAA;AAAA,YACX,MAAM,UAAc,IAAA,KAAA,CAAA;AAAA,WACrB,CAAA,CAAA;AAAA,iBACM,CAAG,EAAA;AACV,UAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,YACT,CAA4C,yCAAA,EAAA,MAAM,CAAa,UAAA,EAAA,YAAY,OAAO,CAAC,CAAA,CAAA;AAAA,WACrF,CAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAM,MAAA,OAAA,GAAgC,YAAa,CAAA,GAAA,CAAI,CAAS,IAAA,MAAA;AAAA,QAC9D,MAAQ,EAAA,aAAA;AAAA,UACN,EAAE,MAAM,UAAW,EAAA;AAAA,UACnB,WAAA;AAAA,UACA,IAAI,KAAM,CAAA,YAAA;AAAA,SACZ;AAAA,QACA,QAAA,EAAU,aACNN,qBAAK,CAAA,KAAA,CAAM,KAAK,UAAY,EAAA,IAAA,CAAK,IAAI,CAAA,GACrC,IAAK,CAAA,IAAA;AAAA,QACT,QAAU,EAAA,QAAA;AAAA,QACV,OAAS,EAAA,IAAA,CAAK,OAAQ,CAAA,QAAA,CAAS,QAAQ,CAAA;AAAA,QACvC,kBAAkB,IAAK,CAAA,UAAA;AAAA,OACvB,CAAA,CAAA,CAAA;AAEF,MAAI,IAAA;AACF,QAAA,MAAM,IAAI,QAAS,CAAA,MAAA,CAAO,QAAQ,UAAY,EAAA,MAAA,CAAO,YAAY,CAAC,CAAA,CAAA;AAAA,eAC3D,CAAG,EAAA;AACV,QAAA,MAAM,IAAIO,iBAAA;AAAA,UACR,CAAA,iGAAA,EAAoG,UAAU,CAAA,GAAA,EAAM,CAAC,CAAA,CAAA;AAAA,SACvH,CAAA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAM,MAAA,GAAA,CAAI,QAAQ,MAAO,CAAA,MAAA,EAAQ,YAAY,GAAI,CAAA,KAAA,CAAM,OAAO,OAAO,CAAA,CAAA;AAAA,eAC9D,CAAG,EAAA;AACV,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,CAAA,0BAAA,EAA6B,UAAU,CAAA,qFAAA,EAAwF,CAAC,CAAA,CAAA;AAAA,SAClI,CAAA;AAAA,OACF;AAEA,MAAI,IAAA;AACF,QAAM,MAAA,eAAA,GAAkB,MAAM,GAAA,CAAI,aAAc,CAAA,MAAA;AAAA,UAC9C,MAAA;AAAA,UACA,UAAA;AAAA,UACA,OAAO,YAAY,CAAA;AAAA,UACnB,KAAA;AAAA,UACA;AAAA,YACE,WAAA;AAAA,YACA,kBAAA,EAAoB,qBAAqB,kBAAqB,GAAA,KAAA;AAAA,YAC9D,UAAA;AAAA,WACF;AAAA,SACF,CAAE,IAAK,CAAA,CAAC,YAAsC,KAAA;AAC5C,UAAA,OAAO,YAAa,CAAA,OAAA,CAAA;AAAA,SACrB,CAAA,CAAA;AACD,QAAI,GAAA,CAAA,MAAA,CAAO,aAAa,MAAM,CAAA,CAAA;AAC9B,QAAI,GAAA,CAAA,MAAA,CAAO,oBAAoB,YAAY,CAAA,CAAA;AAC3C,QAAI,GAAA,CAAA,MAAA,CAAO,eAAe,MAAM,CAAA,CAAA;AAChC,QAAI,GAAA,CAAA,MAAA,CAAO,mBAAmB,eAAe,CAAA,CAAA;AAAA,eACtC,CAAG,EAAA;AACV,QAAA,MAAM,IAAIA,iBAAA,CAAW,CAAgC,6BAAA,EAAA,CAAC,CAAE,CAAA,CAAA,CAAA;AAAA,OAC1D;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/actions/gitlabMergeRequest.examples.cjs.js

@@ -0,0 +1,134 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Create a merge request with a specific assignee",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            description: "This MR is really good",
+            sourcePath: "./path/to/my/changes",
+            branchName: "new-mr",
+            assignee: "my-assignee"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a merge request with removal of source branch after merge",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            description: "This MR is really good",
+            sourcePath: "./path/to/my/changes",
+            branchName: "new-mr",
+            removeSourceBranch: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a merge request with a target branch",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            description: "This MR is really good",
+            sourcePath: "./path/to/my/changes",
+            branchName: "new-mr",
+            targetBranchName: "test",
+            targetPath: "Subdirectory"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a merge request with a commit action as create",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            branchName: "new-mr",
+            description: "MR description",
+            commitAction: "create",
+            targetPath: "source"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a merge request with a commit action as delete",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            branchName: "new-mr",
+            description: "MR description",
+            commitAction: "delete",
+            targetPath: "source"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a merge request with a commit action as update",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createMergeRequest",
+          action: "publish:gitlab:merge-request",
+          name: "Create a Merge Request",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            title: "Create my new MR",
+            branchName: "new-mr",
+            description: "MR description",
+            commitAction: "update",
+            targetPath: "source"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=gitlabMergeRequest.examples.cjs.js.map

package/dist/actions/gitlabMergeRequest.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabMergeRequest.examples.cjs.js","sources":["../../src/actions/gitlabMergeRequest.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Create a merge request with a specific assignee',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            description: 'This MR is really good',\n            sourcePath: './path/to/my/changes',\n            branchName: 'new-mr',\n            assignee: 'my-assignee',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a merge request with removal of source branch after merge',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            description: 'This MR is really good',\n            sourcePath: './path/to/my/changes',\n            branchName: 'new-mr',\n            removeSourceBranch: true,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a merge request with a target branch',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            description: 'This MR is really good',\n            sourcePath: './path/to/my/changes',\n            branchName: 'new-mr',\n            targetBranchName: 'test',\n            targetPath: 'Subdirectory',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a merge request with a commit action as create',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            branchName: 'new-mr',\n            description: 'MR description',\n            commitAction: 'create',\n            targetPath: 'source',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a merge request with a commit action as delete',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            branchName: 'new-mr',\n            description: 'MR description',\n            commitAction: 'delete',\n            targetPath: 'source',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a merge request with a commit action as update',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createMergeRequest',\n          action: 'publish:gitlab:merge-request',\n          name: 'Create a Merge Request',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            title: 'Create my new MR',\n            branchName: 'new-mr',\n            description: 'MR description',\n            commitAction: 'update',\n            targetPath: 'source',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAkBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,iDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA,wBAAA;AAAA,YACb,UAAY,EAAA,sBAAA;AAAA,YACZ,UAAY,EAAA,QAAA;AAAA,YACZ,QAAU,EAAA,aAAA;AAAA,WACZ;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,kEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA,wBAAA;AAAA,YACb,UAAY,EAAA,sBAAA;AAAA,YACZ,UAAY,EAAA,QAAA;AAAA,YACZ,kBAAoB,EAAA,IAAA;AAAA,WACtB;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,6CAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,WAAa,EAAA,wBAAA;AAAA,YACb,UAAY,EAAA,sBAAA;AAAA,YACZ,UAAY,EAAA,QAAA;AAAA,YACZ,gBAAkB,EAAA,MAAA;AAAA,YAClB,UAAY,EAAA,cAAA;AAAA,WACd;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,uDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,UAAY,EAAA,QAAA;AAAA,YACZ,WAAa,EAAA,gBAAA;AAAA,YACb,YAAc,EAAA,QAAA;AAAA,YACd,UAAY,EAAA,QAAA;AAAA,WACd;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,uDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,UAAY,EAAA,QAAA;AAAA,YACZ,WAAa,EAAA,gBAAA;AAAA,YACb,YAAc,EAAA,QAAA;AAAA,YACd,UAAY,EAAA,QAAA;AAAA,WACd;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,uDAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,oBAAA;AAAA,UACJ,MAAQ,EAAA,8BAAA;AAAA,UACR,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,KAAO,EAAA,kBAAA;AAAA,YACP,UAAY,EAAA,QAAA;AAAA,YACZ,WAAa,EAAA,gBAAA;AAAA,YACb,YAAc,EAAA,QAAA;AAAA,YACd,UAAY,EAAA,QAAA;AAAA,WACd;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/actions/gitlabPipelineTrigger.cjs.js

@@ -0,0 +1,89 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var zod = require('zod');
+var commonGitlabConfig = require('../commonGitlabConfig.cjs.js');
+var util = require('../util.cjs.js');
+var gitlabPipelineTrigger_examples = require('./gitlabPipelineTrigger.examples.cjs.js');
+
+const pipelineInputProperties = zod.z.object({
+  projectId: zod.z.number().describe("Project Id"),
+  tokenDescription: zod.z.string().describe("Pipeline token description"),
+  branch: zod.z.string().describe("Project branch"),
+  variables: zod.z.record(zod.z.string(), zod.z.string()).optional().describe(
+    "A object/record of key-valued strings containing the pipeline variables."
+  )
+});
+const pipelineOutputProperties = zod.z.object({
+  pipelineUrl: zod.z.string({ description: "Pipeline Url" })
+});
+const createTriggerGitlabPipelineAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:pipeline:trigger",
+    description: "Triggers a GitLab Pipeline.",
+    examples: gitlabPipelineTrigger_examples.examples,
+    schema: {
+      input: commonGitlabConfig.default.merge(pipelineInputProperties),
+      output: pipelineOutputProperties
+    },
+    async handler(ctx) {
+      let pipelineTokenResponse = null;
+      const { repoUrl, projectId, tokenDescription, token, branch, variables } = commonGitlabConfig.default.merge(pipelineInputProperties).parse(ctx.input);
+      const { host } = util.parseRepoUrl(repoUrl, integrations);
+      const api = util.getClient({ host, integrations, token });
+      try {
+        pipelineTokenResponse = await api.PipelineTriggerTokens.create(
+          projectId,
+          tokenDescription
+        );
+        if (!pipelineTokenResponse.token) {
+          ctx.logger.error("Failed to create pipeline token.");
+          return;
+        }
+        ctx.logger.info(
+          `Pipeline token id ${pipelineTokenResponse.id} created.`
+        );
+        const pipelineTriggerResponse = await api.PipelineTriggerTokens.trigger(
+          projectId,
+          branch,
+          pipelineTokenResponse.token,
+          { variables }
+        );
+        if (!pipelineTriggerResponse.id) {
+          ctx.logger.error("Failed to trigger pipeline.");
+          return;
+        }
+        ctx.logger.info(`Pipeline id ${pipelineTriggerResponse.id} triggered.`);
+        ctx.output("pipelineUrl", pipelineTriggerResponse.web_url);
+      } catch (error) {
+        if (error instanceof zod.z.ZodError) {
+          throw new errors.InputError(`Validation error: ${error.message}`, {
+            validationErrors: error.errors
+          });
+        }
+        throw new errors.InputError(`Failed to trigger Pipeline: ${error.message}`);
+      } finally {
+        if (pipelineTokenResponse && pipelineTokenResponse.id) {
+          try {
+            await api.PipelineTriggerTokens.remove(
+              projectId,
+              pipelineTokenResponse.id
+            );
+            ctx.logger.info(
+              `Deleted pipeline token ${pipelineTokenResponse.id}.`
+            );
+          } catch (error) {
+            ctx.logger.error(
+              `Failed to delete pipeline token id ${pipelineTokenResponse.id}.`
+            );
+          }
+        }
+      }
+    }
+  });
+};
+
+exports.createTriggerGitlabPipelineAction = createTriggerGitlabPipelineAction;
+//# sourceMappingURL=gitlabPipelineTrigger.cjs.js.map

package/dist/actions/gitlabPipelineTrigger.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabPipelineTrigger.cjs.js","sources":["../../src/actions/gitlabPipelineTrigger.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport {\n  ExpandedPipelineSchema,\n  PipelineTriggerTokenSchema,\n} from '@gitbeaker/rest';\nimport { z } from 'zod';\nimport commonGitlabConfig from '../commonGitlabConfig';\nimport { getClient, parseRepoUrl } from '../util';\nimport { examples } from './gitlabPipelineTrigger.examples';\n\nconst pipelineInputProperties = z.object({\n  projectId: z.number().describe('Project Id'),\n  tokenDescription: z.string().describe('Pipeline token description'),\n  branch: z.string().describe('Project branch'),\n  variables: z\n    .record(z.string(), z.string())\n    .optional()\n    .describe(\n      'A object/record of key-valued strings containing the pipeline variables.',\n    ),\n});\n\nconst pipelineOutputProperties = z.object({\n  pipelineUrl: z.string({ description: 'Pipeline Url' }),\n});\n\n/**\n * Creates a `gitlab:pipeline:trigger` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createTriggerGitlabPipelineAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction({\n    id: 'gitlab:pipeline:trigger',\n    description: 'Triggers a GitLab Pipeline.',\n    examples,\n    schema: {\n      input: commonGitlabConfig.merge(pipelineInputProperties),\n      output: pipelineOutputProperties,\n    },\n    async handler(ctx) {\n      let pipelineTokenResponse: PipelineTriggerTokenSchema | null = null;\n\n      const { repoUrl, projectId, tokenDescription, token, branch, variables } =\n        commonGitlabConfig.merge(pipelineInputProperties).parse(ctx.input);\n\n      const { host } = parseRepoUrl(repoUrl, integrations);\n      const api = getClient({ host, integrations, token });\n\n      try {\n        // Create a pipeline token\n        pipelineTokenResponse = (await api.PipelineTriggerTokens.create(\n          projectId,\n          tokenDescription,\n        )) as PipelineTriggerTokenSchema;\n\n        if (!pipelineTokenResponse.token) {\n          ctx.logger.error('Failed to create pipeline token.');\n          return;\n        }\n        ctx.logger.info(\n          `Pipeline token id ${pipelineTokenResponse.id} created.`,\n        );\n\n        // Use the pipeline token to trigger the pipeline in the project\n        const pipelineTriggerResponse =\n          (await api.PipelineTriggerTokens.trigger(\n            projectId,\n            branch,\n            pipelineTokenResponse.token,\n            { variables },\n          )) as ExpandedPipelineSchema;\n\n        if (!pipelineTriggerResponse.id) {\n          ctx.logger.error('Failed to trigger pipeline.');\n          return;\n        }\n\n        ctx.logger.info(`Pipeline id ${pipelineTriggerResponse.id} triggered.`);\n\n        ctx.output('pipelineUrl', pipelineTriggerResponse.web_url);\n      } catch (error: any) {\n        if (error instanceof z.ZodError) {\n          // Handling Zod validation errors\n          throw new InputError(`Validation error: ${error.message}`, {\n            validationErrors: error.errors,\n          });\n        }\n        // Handling other errors\n        throw new InputError(`Failed to trigger Pipeline: ${error.message}`);\n      } finally {\n        // Delete the pipeline token if it was created\n        if (pipelineTokenResponse && pipelineTokenResponse.id) {\n          try {\n            await api.PipelineTriggerTokens.remove(\n              projectId,\n              pipelineTokenResponse.id,\n            );\n            ctx.logger.info(\n              `Deleted pipeline token ${pipelineTokenResponse.id}.`,\n            );\n          } catch (error: any) {\n            ctx.logger.error(\n              `Failed to delete pipeline token id ${pipelineTokenResponse.id}.`,\n            );\n          }\n        }\n      }\n    },\n  });\n};\n"],"names":["z","createTemplateAction","examples","commonGitlabConfig","parseRepoUrl","getClient","InputError"],"mappings":";;;;;;;;;AA4BA,MAAM,uBAAA,GAA0BA,MAAE,MAAO,CAAA;AAAA,EACvC,SAAW,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,SAAS,YAAY,CAAA;AAAA,EAC3C,gBAAkB,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,SAAS,4BAA4B,CAAA;AAAA,EAClE,MAAQ,EAAAA,KAAA,CAAE,MAAO,EAAA,CAAE,SAAS,gBAAgB,CAAA;AAAA,EAC5C,SAAA,EAAWA,KACR,CAAA,MAAA,CAAOA,KAAE,CAAA,MAAA,EAAU,EAAAA,KAAA,CAAE,MAAO,EAAC,CAC7B,CAAA,QAAA,EACA,CAAA,QAAA;AAAA,IACC,0EAAA;AAAA,GACF;AACJ,CAAC,CAAA,CAAA;AAED,MAAM,wBAAA,GAA2BA,MAAE,MAAO,CAAA;AAAA,EACxC,aAAaA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,gBAAgB,CAAA;AACvD,CAAC,CAAA,CAAA;AAQY,MAAA,iCAAA,GAAoC,CAAC,OAE5C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOC,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,yBAAA;AAAA,IACJ,WAAa,EAAA,6BAAA;AAAA,cACbC,uCAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAA,EAAOC,0BAAmB,CAAA,KAAA,CAAM,uBAAuB,CAAA;AAAA,MACvD,MAAQ,EAAA,wBAAA;AAAA,KACV;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,IAAI,qBAA2D,GAAA,IAAA,CAAA;AAE/D,MAAA,MAAM,EAAE,OAAA,EAAS,SAAW,EAAA,gBAAA,EAAkB,OAAO,MAAQ,EAAA,SAAA,EAC3D,GAAAA,0BAAA,CAAmB,KAAM,CAAA,uBAAuB,CAAE,CAAA,KAAA,CAAM,IAAI,KAAK,CAAA,CAAA;AAEnE,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,iBAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AACnD,MAAA,MAAM,MAAMC,cAAU,CAAA,EAAE,IAAM,EAAA,YAAA,EAAc,OAAO,CAAA,CAAA;AAEnD,MAAI,IAAA;AAEF,QAAyB,qBAAA,GAAA,MAAM,IAAI,qBAAsB,CAAA,MAAA;AAAA,UACvD,SAAA;AAAA,UACA,gBAAA;AAAA,SACF,CAAA;AAEA,QAAI,IAAA,CAAC,sBAAsB,KAAO,EAAA;AAChC,UAAI,GAAA,CAAA,MAAA,CAAO,MAAM,kCAAkC,CAAA,CAAA;AACnD,UAAA,OAAA;AAAA,SACF;AACA,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,CAAA,kBAAA,EAAqB,sBAAsB,EAAE,CAAA,SAAA,CAAA;AAAA,SAC/C,CAAA;AAGA,QAAM,MAAA,uBAAA,GACH,MAAM,GAAA,CAAI,qBAAsB,CAAA,OAAA;AAAA,UAC/B,SAAA;AAAA,UACA,MAAA;AAAA,UACA,qBAAsB,CAAA,KAAA;AAAA,UACtB,EAAE,SAAU,EAAA;AAAA,SACd,CAAA;AAEF,QAAI,IAAA,CAAC,wBAAwB,EAAI,EAAA;AAC/B,UAAI,GAAA,CAAA,MAAA,CAAO,MAAM,6BAA6B,CAAA,CAAA;AAC9C,UAAA,OAAA;AAAA,SACF;AAEA,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAe,YAAA,EAAA,uBAAA,CAAwB,EAAE,CAAa,WAAA,CAAA,CAAA,CAAA;AAEtE,QAAI,GAAA,CAAA,MAAA,CAAO,aAAe,EAAA,uBAAA,CAAwB,OAAO,CAAA,CAAA;AAAA,eAClD,KAAY,EAAA;AACnB,QAAI,IAAA,KAAA,YAAiBL,MAAE,QAAU,EAAA;AAE/B,UAAA,MAAM,IAAIM,iBAAA,CAAW,CAAqB,kBAAA,EAAA,KAAA,CAAM,OAAO,CAAI,CAAA,EAAA;AAAA,YACzD,kBAAkB,KAAM,CAAA,MAAA;AAAA,WACzB,CAAA,CAAA;AAAA,SACH;AAEA,QAAA,MAAM,IAAIA,iBAAA,CAAW,CAA+B,4BAAA,EAAA,KAAA,CAAM,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,OACnE,SAAA;AAEA,QAAI,IAAA,qBAAA,IAAyB,sBAAsB,EAAI,EAAA;AACrD,UAAI,IAAA;AACF,YAAA,MAAM,IAAI,qBAAsB,CAAA,MAAA;AAAA,cAC9B,SAAA;AAAA,cACA,qBAAsB,CAAA,EAAA;AAAA,aACxB,CAAA;AACA,YAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,cACT,CAAA,uBAAA,EAA0B,sBAAsB,EAAE,CAAA,CAAA,CAAA;AAAA,aACpD,CAAA;AAAA,mBACO,KAAY,EAAA;AACnB,YAAA,GAAA,CAAI,MAAO,CAAA,KAAA;AAAA,cACT,CAAA,mCAAA,EAAsC,sBAAsB,EAAE,CAAA,CAAA,CAAA;AAAA,aAChE,CAAA;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/actions/gitlabPipelineTrigger.examples.cjs.js

@@ -0,0 +1,94 @@
+'use strict';
+
+var yaml = require('yaml');
+var commonGitlabConfig = require('../commonGitlabConfig.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Trigger a GitLab Project Pipeline",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "triggerPipeline",
+          name: "Trigger Project Pipeline",
+          action: "gitlab:pipeline:trigger",
+          input: {
+            ...commonGitlabConfig.commonGitlabConfigExample,
+            projectId: 12,
+            tokenDescription: "This is the text that will appear in the pipeline token",
+            token: "glpt-xxxxxxxxxxxx",
+            branch: "main",
+            variables: { var_one: "one", var_two: "two" }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Trigger a GitLab Project Pipeline with No Variables",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "triggerPipeline",
+          name: "Trigger Project Pipeline",
+          action: "gitlab:pipeline:trigger",
+          input: {
+            ...commonGitlabConfig.commonGitlabConfigExample,
+            projectId: 12,
+            tokenDescription: "This is the text that will appear in the pipeline token",
+            token: "glpt-xxxxxxxxxxxx",
+            branch: "main",
+            variables: {}
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Trigger a GitLab Project Pipeline with Single Variables",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "triggerPipeline",
+          name: "Trigger Project Pipeline",
+          action: "gitlab:pipeline:trigger",
+          input: {
+            ...commonGitlabConfig.commonGitlabConfigExample,
+            projectId: 12,
+            tokenDescription: "This is the text that will appear in the pipeline token",
+            token: "glpt-xxxxxxxxxxxx",
+            branch: "main",
+            variables: { var_one: "one" }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Trigger a GitLab Project Pipeline with Multiple Variables",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "triggerPipeline",
+          name: "Trigger Project Pipeline",
+          action: "gitlab:pipeline:trigger",
+          input: {
+            ...commonGitlabConfig.commonGitlabConfigExample,
+            projectId: 12,
+            tokenDescription: "This is the text that will appear in the pipeline token",
+            token: "glpt-xxxxxxxxxxxx",
+            branch: "main",
+            variables: { var_one: "one", var_two: "two", var_three: "three" }
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=gitlabPipelineTrigger.examples.cjs.js.map

package/dist/actions/gitlabPipelineTrigger.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabPipelineTrigger.examples.cjs.js","sources":["../../src/actions/gitlabPipelineTrigger.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\nimport { commonGitlabConfigExample } from '../commonGitlabConfig';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Trigger a GitLab Project Pipeline',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'triggerPipeline',\n          name: 'Trigger Project Pipeline',\n          action: 'gitlab:pipeline:trigger',\n          input: {\n            ...commonGitlabConfigExample,\n            projectId: 12,\n            tokenDescription:\n              'This is the text that will appear in the pipeline token',\n            token: 'glpt-xxxxxxxxxxxx',\n            branch: 'main',\n            variables: { var_one: 'one', var_two: 'two' },\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Trigger a GitLab Project Pipeline with No Variables',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'triggerPipeline',\n          name: 'Trigger Project Pipeline',\n          action: 'gitlab:pipeline:trigger',\n          input: {\n            ...commonGitlabConfigExample,\n            projectId: 12,\n            tokenDescription:\n              'This is the text that will appear in the pipeline token',\n            token: 'glpt-xxxxxxxxxxxx',\n            branch: 'main',\n            variables: {},\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Trigger a GitLab Project Pipeline with Single Variables',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'triggerPipeline',\n          name: 'Trigger Project Pipeline',\n          action: 'gitlab:pipeline:trigger',\n          input: {\n            ...commonGitlabConfigExample,\n            projectId: 12,\n            tokenDescription:\n              'This is the text that will appear in the pipeline token',\n            token: 'glpt-xxxxxxxxxxxx',\n            branch: 'main',\n            variables: { var_one: 'one' },\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Trigger a GitLab Project Pipeline with Multiple Variables',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'triggerPipeline',\n          name: 'Trigger Project Pipeline',\n          action: 'gitlab:pipeline:trigger',\n          input: {\n            ...commonGitlabConfigExample,\n            projectId: 12,\n            tokenDescription:\n              'This is the text that will appear in the pipeline token',\n            token: 'glpt-xxxxxxxxxxxx',\n            branch: 'main',\n            variables: { var_one: 'one', var_two: 'two', var_three: 'three' },\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml","commonGitlabConfigExample"],"mappings":";;;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,mCAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,iBAAA;AAAA,UACJ,IAAM,EAAA,0BAAA;AAAA,UACN,MAAQ,EAAA,yBAAA;AAAA,UACR,KAAO,EAAA;AAAA,YACL,GAAGC,4CAAA;AAAA,YACH,SAAW,EAAA,EAAA;AAAA,YACX,gBACE,EAAA,yDAAA;AAAA,YACF,KAAO,EAAA,mBAAA;AAAA,YACP,MAAQ,EAAA,MAAA;AAAA,YACR,SAAW,EAAA,EAAE,OAAS,EAAA,KAAA,EAAO,SAAS,KAAM,EAAA;AAAA,WAC9C;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,qDAAA;AAAA,IACb,OAAA,EAASD,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,iBAAA;AAAA,UACJ,IAAM,EAAA,0BAAA;AAAA,UACN,MAAQ,EAAA,yBAAA;AAAA,UACR,KAAO,EAAA;AAAA,YACL,GAAGC,4CAAA;AAAA,YACH,SAAW,EAAA,EAAA;AAAA,YACX,gBACE,EAAA,yDAAA;AAAA,YACF,KAAO,EAAA,mBAAA;AAAA,YACP,MAAQ,EAAA,MAAA;AAAA,YACR,WAAW,EAAC;AAAA,WACd;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,yDAAA;AAAA,IACb,OAAA,EAASD,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,iBAAA;AAAA,UACJ,IAAM,EAAA,0BAAA;AAAA,UACN,MAAQ,EAAA,yBAAA;AAAA,UACR,KAAO,EAAA;AAAA,YACL,GAAGC,4CAAA;AAAA,YACH,SAAW,EAAA,EAAA;AAAA,YACX,gBACE,EAAA,yDAAA;AAAA,YACF,KAAO,EAAA,mBAAA;AAAA,YACP,MAAQ,EAAA,MAAA;AAAA,YACR,SAAA,EAAW,EAAE,OAAA,EAAS,KAAM,EAAA;AAAA,WAC9B;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,2DAAA;AAAA,IACb,OAAA,EAASD,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,iBAAA;AAAA,UACJ,IAAM,EAAA,0BAAA;AAAA,UACN,MAAQ,EAAA,yBAAA;AAAA,UACR,KAAO,EAAA;AAAA,YACL,GAAGC,4CAAA;AAAA,YACH,SAAW,EAAA,EAAA;AAAA,YACX,gBACE,EAAA,yDAAA;AAAA,YACF,KAAO,EAAA,mBAAA;AAAA,YACP,MAAQ,EAAA,MAAA;AAAA,YACR,WAAW,EAAE,OAAA,EAAS,OAAO,OAAS,EAAA,KAAA,EAAO,WAAW,OAAQ,EAAA;AAAA,WAClE;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}