fix: gitlab authentication with username and token

Author: JounQin

.changeset/twelve-seas-mate.md

@@ -0,0 +1,5 @@
+---
+'changesets-gitlab': patch
+---
+
+fix: gitlab authentication with username and token

README.md

@@ -18,6 +18,21 @@ GitLab CI cli for [changesets](https://github.com/atlassian/changesets) like its
 - published - A boolean value to indicate whether a publishing is happened or not
 - publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
 
+### Environment Variables
+
+```sh
+GLOBAL_AGENT_HTTP_PROXY  # optional, if you're using custom GitLab service under proxy
+GLOBAL_AGENT_HTTPS_PROXY # As above but for https requests
+GLOBAL_AGENT_NO_PROXY    # Like above but for no proxied requests
+
+# http_proxy, https_proxy, no_proxy environment variables are supported at the same time
+
+GITLAB_HOST # optional, if you're using custom GitLab host
+
+GITLAB_TOKEN     # required, token with accessibility to push
+GITLAB_USER_NAME # required, username with accessibility to push, used in pairs of the above token
+```
+
 ### Example workflow
 
 #### Without Publishing

src/cli.ts

@@ -2,8 +2,11 @@
 
 import './env.js'
 
+import { URL } from 'url'
+
 import { getInput, setFailed, setOutput } from '@actions/core'
 import fs from 'fs-extra'
+import { exec } from '@actions/exec'
 
 import { setupUser } from './gitUtils.js'
 import readChangesetState from './readChangesetState.js'
@@ -12,14 +15,18 @@ import { runPublish, runVersion } from './run.js'
 const main = async () => {
   const {
     CI,
+    CI_PROJECT_PATH,
     GITLAB_HOST = 'https://gitlab.com',
     GITLAB_TOKEN,
+    GITLAB_USER_NAME,
     HOME,
     NPM_TOKEN,
   } = process.env
 
-  if (!GITLAB_TOKEN) {
-    setFailed('Please add the GITLAB_TOKEN to the changesets action')
+  if (!GITLAB_TOKEN || !GITLAB_USER_NAME) {
+    setFailed(
+      'Please add the `GITLAB_TOKEN` and `GITLAB_USER_NAME` to the changesets action',
+    )
     return
   }
 
@@ -30,14 +37,18 @@ const main = async () => {
     console.log('setting git user')
     await setupUser()
 
-    console.log('setting GitHub credentials')
-    await fs.writeFile(
-      `${HOME!}/.netrc`,
-      `machine ${GITLAB_HOST.replace(
-        /^https?:\/\//,
-        '',
-      )}\nlogin gitlab[bot]\npassword ${GITLAB_TOKEN}`,
-    )
+    console.log('setting GitLab credentials')
+
+    const url = new URL(GITLAB_HOST)
+
+    await exec('git', [
+      'remote',
+      'set-url',
+      'origin',
+      `${url.protocol}//${GITLAB_USER_NAME}:${GITLAB_TOKEN}@${
+        url.host
+      }/${CI_PROJECT_PATH!}.git`,
+    ])
   }
 
   const { changesets } = await readChangesetState()

src/gitUtils.ts

@@ -3,12 +3,17 @@ import { exec } from '@actions/exec'
 import { execWithOutput, identify } from './utils.js'
 
 export const setupUser = async () => {
-  await exec('git', ['config', '--global', 'user.name', `"gitlab[bot]"`])
+  await exec('git', [
+    'config',
+    '--global',
+    'user.name',
+    process.env.GITLAB_USER_NAME!,
+  ])
   await exec('git', [
     'config',
     '--global',
     'user.email',
-    `"gitlab[bot]@users.noreply.gitlab.com"`,
+    process.env.GITLAB_USER_EMAIL || '"gitlab[bot]@users.noreply.gitlab.com"',
   ])
 }
 

src/run.ts

@@ -201,7 +201,7 @@ export async function runVersion({
   const { preState } = await readChangesetState(cwd)
 
   await gitUtils.switchToMaybeExistingBranch(versionBranch)
-  await gitUtils.reset(branch)
+  await gitUtils.reset(`origin/${branch}`)
 
   const versionsByDirectory = await getVersionsByDirectory(cwd)