feat: use gitlab api to get username (#76)

Co-authored-by: Daniel Kopp <daniel.kopp@aoe.com>
Resolves #63

Author: devtribe

.changeset/two-sheep-itch.md

@@ -0,0 +1,5 @@
+---
+'changesets-gitlab': minor
+---
+
+get username from api instead usage of env variable

README.md

@@ -48,7 +48,7 @@ GITLAB_HOST # optional, if you're using custom GitLab host
 
 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     # required, username with accessibility to push, used in pairs of the above token (if it was personal access 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`
 DEBUG_GITLAB_CREDENTIAL # optional, default `false`
 ```

src/cli.ts

@@ -15,12 +15,10 @@ const cjsRequire =
   typeof require === 'undefined' ? _.createRequire(import.meta.url) : require
 
 const run = async () => {
-  const { GITLAB_CI_USER_NAME, GITLAB_TOKEN } = process.env
+  const { GITLAB_TOKEN } = process.env
 
-  if (!GITLAB_TOKEN || !GITLAB_CI_USER_NAME) {
-    setFailed(
-      'Please add the `GITLAB_TOKEN` and `GITLAB_CI_USER_NAME` to the changesets action',
-    )
+  if (!GITLAB_TOKEN) {
+    setFailed('Please add the `GITLAB_TOKEN` to the changesets action')
     return
   }
 

src/comment.ts

@@ -1,7 +1,7 @@
 import { ValidationError } from '@changesets/errors'
 import type {
-  ReleasePlan,
   ComprehensiveRelease,
+  ReleasePlan,
   VersionType,
 } from '@changesets/types'
 import type { Gitlab, MergeRequests } from '@gitbeaker/core'
@@ -11,9 +11,12 @@ import { markdownTable } from 'markdown-table'
 
 import * as context from './context.js'
 import { getChangedPackages } from './get-changed-packages.js'
+import { getUsername } from './utils.js'
 
 import { createApi } from './index.js'
 
+const generatedByBotNote = 'Generated By Changesets GitLab Bot'
+
 const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
   if (!releasePlan) return ''
 
@@ -69,7 +72,7 @@ ${getReleasePlanMessage(releasePlan)}
 
 [Click here if you're a maintainer who wants to add a changeset to this MR](${addChangesetUrl})
 
-__Generated By Changesets GitLab Bot__
+__${generatedByBotNote}__
 `
 
 const getApproveMessage = (
@@ -88,7 +91,7 @@ Not sure what this means? [Click here  to learn what changesets are](https://git
 
 [Click here if you're a maintainer who wants to add another changeset to this MR](${addChangesetUrl})
 
-__Generated By Changesets GitLab Bot__
+__${generatedByBotNote}__
 `
 
 const getNewChangesetTemplate = (changedPackages: string[], title: string) =>
@@ -101,18 +104,19 @@ ${title}
 
 const getNoteInfo = (api: Gitlab, mrIid: number | string) =>
   api.MergeRequestDiscussions.all(context.projectId, mrIid).then(
-    discussions => {
+    async discussions => {
       for (const discussion of discussions) {
         if (!discussion.notes) {
           continue
         }
 
+        const username = await getUsername(api)
         const changesetBotNote = discussion.notes.find(
           note =>
-            note.author.username === process.env.GITLAB_CI_USER_NAME &&
-            // We need to ensure the note is generated by us but we don't have a app bot like GitHub
+            note.author.username === username &&
+            // We need to ensure the note is generated by us, but we don't have an app bot like GitHub
             // @see https://github.com/apps/changeset-bot
-            note.body.includes('Generated By Changesets GitLab Bot'),
+            note.body.includes(generatedByBotNote),
         )
 
         if (changesetBotNote) {

src/main.ts

@@ -8,7 +8,9 @@ import { setupUser } from './gitUtils.js'
 import readChangesetState from './readChangesetState.js'
 import { runPublish, runVersion } from './run.js'
 import type { MainCommandOptions } from './types.js'
-import { execSync, getOptionalInput } from './utils.js'
+import { execSync, getOptionalInput, getUsername } from './utils.js'
+
+import { createApi } from './index.js'
 
 export const main = async ({
   published,
@@ -18,7 +20,6 @@ export const main = async ({
     CI,
     CI_PROJECT_PATH,
     GITLAB_HOST = 'https://gitlab.com',
-    GITLAB_CI_USER_NAME,
     GITLAB_TOKEN,
     HOME,
     NPM_TOKEN,
@@ -32,17 +33,18 @@ export const main = async ({
     console.log('setting git user')
     await setupUser()
 
-    console.log('setting GitLab credentials')
-
     const url = new URL(GITLAB_HOST)
 
+    console.log('setting GitLab credentials')
+    const username = await getUsername(createApi())
+
     await exec(
       'git',
       [
         'remote',
         'set-url',
         'origin',
-        `${url.protocol}//${GITLAB_CI_USER_NAME!}:${GITLAB_TOKEN!}@${
+        `${url.protocol}//${username}:${GITLAB_TOKEN!}@${
           url.host
         }/${CI_PROJECT_PATH!}.git`,
       ],

src/utils.ts

@@ -4,6 +4,7 @@ import path from 'node:path'
 
 import { getInput } from '@actions/core'
 import { exec } from '@actions/exec'
+import type { Gitlab } from '@gitbeaker/core'
 import type { Package } from '@manypkg/get-packages'
 import { getPackages } from '@manypkg/get-packages'
 import { toString as mdastToString } from 'mdast-util-to-string'
@@ -152,3 +153,9 @@ export const execSync = (command: string) =>
   })
 
 export const getOptionalInput = (name: string) => getInput(name) || undefined
+
+export const getUsername = async (api: Gitlab) => {
+  return process.env.GITLAB_CI_USER_NAME == null
+    ? await api.Users.current().then(currentUser => currentUser.username)
+    : process.env.GITLAB_CI_USER_NAME
+}