feat: add GITLAB_COMMENT_TYPE env variable to use discussions or notes (#98)

Co-authored-by: JounQin <admin@1stg.me>

Author: QuiiBz

.changeset/thin-foxes-serve.md

@@ -0,0 +1,5 @@
+---
+'changesets-gitlab': minor
+---
+
+feat: add new `GITLAB_COMMENT_TYPE` environment variable to use discussions or notes

README.md

@@ -52,6 +52,7 @@ GITLAB_TOKEN            # required, token with accessibility to push
 GITLAB_TOKEN_TYPE       # optional, type of the provided token in GITLAB_TOKEN. defaults to personal access token. can be `job` if you provide the Gitlab CI_JOB_TOKEN or `oauth` if you use Gitlab Oauth token
 GITLAB_CI_USER_NAME     # optional, username with accessibility to push, used in pairs of the above token (if it was personal access token). If not set read it from the Gitlab API
 GITLAB_CI_USER_EMAIL    # optional, default `gitlab[bot]@users.noreply.gitlab.com`
+GITLAB_COMMENT_TYPE     # optional, type of the comment. defaults to `discussion`. can be set to `note` to not create a discussion instead of a thread
 DEBUG_GITLAB_CREDENTIAL # optional, default `false`
 ```
 

src/comment.ts

@@ -141,13 +141,38 @@ const hasChangesetBeenAdded = (
     ),
   )
 
+const getCommentFunctions = (api: Gitlab, commentType: string) => {
+  if (commentType === 'discussion') {
+    return {
+      editComment: api.MergeRequestDiscussions.editNote.bind(
+        api.MergeRequestDiscussions,
+      ),
+      createComment: api.MergeRequestDiscussions.create.bind(
+        api.MergeRequestDiscussions,
+      ),
+    }
+  }
+
+  if (commentType === 'note') {
+    return {
+      editComment: api.MergeRequestNotes.edit.bind(api.MergeRequestNotes),
+      createComment: api.MergeRequestNotes.create.bind(api.MergeRequestNotes),
+    }
+  }
+
+  throw new Error(
+    `Invalid comment type "${commentType}", should be "discussion" or "note"`,
+  )
+}
+
 export const comment = async () => {
   const {
     CI_MERGE_REQUEST_IID,
     CI_MERGE_REQUEST_PROJECT_URL,
     CI_MERGE_REQUEST_SOURCE_BRANCH_NAME: mrBranch,
     CI_MERGE_REQUEST_SOURCE_BRANCH_SHA,
     CI_MERGE_REQUEST_TITLE,
+    GITLAB_COMMENT_TYPE = 'discussion',
   } = process.env
 
   if (!mrBranch) {
@@ -211,8 +236,13 @@ export const comment = async () => {
         : getAbsentMessage(latestCommitSha, addChangesetUrl, releasePlan)) +
       errFromFetchingChangedFiles
 
+    const { editComment, createComment } = getCommentFunctions(
+      api,
+      GITLAB_COMMENT_TYPE,
+    )
+
     if (noteInfo != null) {
-      return api.MergeRequestDiscussions.editNote(
+      return editComment(
         context.projectId,
         mrIid,
         // @ts-expect-error - https://github.com/jdalrymple/gitbeaker/pull/523#issuecomment-975276068
@@ -223,11 +253,7 @@ export const comment = async () => {
         },
       )
     }
-    return api.MergeRequestDiscussions.create(
-      context.projectId,
-      mrIid,
-      prComment,
-    )
+    return createComment(context.projectId, mrIid, prComment)
   } catch (err: unknown) {
     console.error(err)
     throw err