@backstage/plugin-scaffolder-backend-module-gitlab 0.4.4 → 0.4.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/plugin-scaffolder-backend-module-gitlab
 
+## 0.4.5-next.0
+
+### Patch Changes
+
+- fad1b90: Allow the `createGitlabProjectVariableAction` to use oauth tokens
+- aab708e: Added test cases for gitlab:issue:edit examples
+- ef742dc: Added test cases for gitlab:projectAccessToken:create example
+- 1ba4c2f: Added test cases for gitlab:pipeline:trigger examples
+- a6603e4: Add custom action for merge request: **auto**
+
+  The **Auto** action selects the committed action between _create_ and _update_.
+
+  The **Auto** action fetches files using the **/projects/repository/tree endpoint**.
+  After fetching, it checks if the file exists locally and in the repository. If it does, it chooses **update**; otherwise, it chooses **create**.
+
+- Updated dependencies
+  - @backstage/backend-common@0.23.4-next.0
+  - @backstage/integration@1.14.0-next.0
+  - @backstage/backend-plugin-api@0.7.1-next.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-scaffolder-node@0.4.9-next.0
+
 ## 0.4.4
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1020,7 +1020,7 @@ const examples$6 = [
             title: "Test Issue",
             assignees: [18],
             description: "This is the edited description of the issue",
-            updatedAt: "2024-05-10 18:00:00.000",
+            updatedAt: "2024-05-10T18:00:00.000Z",
             dueDate: "2024-09-28"
           }
         }
@@ -1042,7 +1042,7 @@ const examples$6 = [
             assignees: [18, 15],
             description: "This is the description of the issue",
             confidential: false,
-            updatedAt: "2024-05-10 18:00:00.000",
+            updatedAt: "2024-05-10T18:00:00.000Z",
             dueDate: "2024-09-28",
             discussionLocked: true,
             epicId: 1,
@@ -1051,6 +1051,178 @@ const examples$6 = [
         }
       ]
     })
+  },
+  {
+    description: "Edit a gitlab issue to change  its state to close",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            stateEvent: "close"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to change  its state to reopened",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            stateEvent: "reopen"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to assign it to multiple users and set milestone",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Test issue with milestone",
+            assignees: [18, 20],
+            description: "This issue has milestone set",
+            milestoneId: 5
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to add weight and update labels",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Issue with weight and labels",
+            description: "This issue has weight and new labels",
+            weight: 3,
+            labels: "bug,urgent"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to make it confidential",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Confidential Issue",
+            description: "This issue is confidential",
+            confidential: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to lock the discussion",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Locked Discussion Issue",
+            description: "This discussion on this issue is locked",
+            discussionLocked: true
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to remove labels and update milestone",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Issue with labels removed and milestone updated",
+            description: "This issue has labels removed and milestone updated",
+            removeLabels: "phase1:label1",
+            milestoneId: 6
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to remove some labels and new ones",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Issue with labels updated",
+            description: "This issue has labels removed and new ones added",
+            removeLabels: "bug,urgent",
+            labels: "enhancement:documentation"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Edit a gitlab issue to change issue type and add labels",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "gitlabIssue",
+          name: "EditIssues",
+          action: "gitlab:issue:edit",
+          input: {
+            ...commonGitlabConfigExample,
+            projectId: 12,
+            title: "Issue with type and labels",
+            description: "This issue has been changes and new labels added",
+            labels: "task,high-priority",
+            issueType: "task"
+          }
+        }
+      ]
+    })
   }
 ];
 
@@ -1350,6 +1522,13 @@ const examples$5 = [
   }
 ];
 
+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({
@@ -1409,8 +1588,8 @@ const createPublishGitlabMergeRequestAction = (options) => {
           commitAction: {
             title: "Commit action",
             type: "string",
-            enum: ["create", "update", "delete"],
-            description: "The action to be used for git commit. Defaults to create."
+            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",
@@ -1489,19 +1668,37 @@ const createPublishGitlabMergeRequestAction = (options) => {
       const fileContents = await pluginScaffolderNode.serializeDirectoryContents(fileRoot, {
         gitignore: true
       });
-      const actions = fileContents.map((file) => ({
-        action: ctx.input.commitAction ?? "create",
-        filePath: targetPath ? path__default.default.posix.join(targetPath, file.path) : file.path,
-        encoding: "base64",
-        content: file.content.toString("base64"),
-        execute_filemode: file.executable
-      }));
       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) {
@@ -1561,6 +1758,66 @@ const examples$4 = [
         }
       ]
     })
+  },
+  {
+    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: {
+            ...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: {
+            ...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: {
+            ...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" }
+          }
+        }
+      ]
+    })
   }
 ];
 
@@ -1725,6 +1982,160 @@ const examples$3 = [
         }
       ]
     })
+  },
+  {
+    description: "Create a GitLab project access token with an access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456",
+            accessLevel: 30
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with multiple options",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456",
+            accessLevel: 40,
+            name: "full-access-token",
+            expiresAt: "2024-12-31"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a token for authorization",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            token: "personal-access-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with read-only scopes",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            scopes: ["read_repository", "read_api"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with guest access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 10
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with maintainer access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 40
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with owner access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 50
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a specified name and no expiration date",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            name: "no-expiry-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token for a specific gitlab instance",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.example.com?repo=repo&owner=owner",
+            projectId: "101112"
+          }
+        }
+      ]
+    })
   }
 ];
 
@@ -2105,6 +2516,7 @@ const createGitlabProjectVariableAction = (options) => {
     },
     async handler(ctx) {
       const {
+        repoUrl,
         projectId,
         key,
         value,
@@ -2112,21 +2524,17 @@ const createGitlabProjectVariableAction = (options) => {
         variableProtected = false,
         masked = false,
         raw = false,
-        environmentScope = "*"
-      } = ctx.input;
-      const { token, integrationConfig } = getToken(ctx.input, integrations);
-      const api = new node.Gitlab({
-        host: integrationConfig.config.baseUrl,
+        environmentScope = "*",
         token
-      });
-      await api.ProjectVariables.create(projectId, {
-        key,
-        value,
-        variable_type: variableType,
+      } = ctx.input;
+      const { host } = parseRepoUrl(repoUrl, integrations);
+      const api = getClient({ host, integrations, token });
+      await api.ProjectVariables.create(projectId, key, value, {
+        variableType,
         protected: variableProtected,
         masked,
         raw,
-        environment_scope: environmentScope
+        environmentScope
       });
     }
   });