fix(deps): migrate to @gitbeaker/rest (#138)

Co-authored-by: JounQin <[email protected]>

.changeset/eleven-kids-happen.md

@@ -0,0 +1,5 @@
+---
+'changesets-gitlab': minor
+---
+
+Fix deprecation warning of using @gitbeaker/node package

.codesandbox/ci.json

@@ -1,4 +1,4 @@
 {
- "node": "16",
+ "node": "18",
  "sandboxes": []
 }

.github/workflows/ci.yml

@@ -10,22 +10,21 @@ jobs:
  strategy:
  matrix:
  node:
- - 14
- - 16
  - 18
+ - 20
  runs-on: ubuntu-latest
  steps:
  - name: Checkout Repo
  uses: actions/checkout@v3
 
  - name: Setup Node.js ${{ matrix.node }}
- uses: actions/setup-node@v3
+ uses: actions/setup-node@v4
  with:
  node-version: ${{ matrix.node }}
  cache: yarn
 
  - name: Install Dependencies
- run: yarn --frozen-lockfile
+ run: yarn --frozen-lockfile --ignore-engines
 
  - name: Build, Lint and Test
  run: |

.github/workflows/release.yml

@@ -16,10 +16,10 @@ jobs:
  # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
  fetch-depth: 0
 
- - name: Setup Node.js 16
- uses: actions/setup-node@v3
+ - name: Setup Node.js LTS
+ uses: actions/setup-node@v4
  with:
- node-version: 16
+ node-version: lts/*
  cache: yarn
 
  - name: Install Dependencies

package.json

@@ -77,7 +77,7 @@
  "@changesets/parse": "^0.3.16",
  "@changesets/pre": "^1.0.14",
  "@changesets/read": "^0.5.9",
- "@gitbeaker/node": "^35.7.0",
+ "@gitbeaker/rest": "^39.23.0",
  "@manypkg/get-packages": "^1.1.3",
  "@sentry/node": "^7.6.0",
  "commander": "^9.3.0",

src/comment.ts

@@ -129,17 +129,20 @@ const getNoteInfo = (api: Gitlab, mrIid: number | string) =>
  },
  )
 
-const hasChangesetBeenAdded = (
- changedFilesPromise: ReturnType<MergeRequests['changes']>,
-) =>
- changedFilesPromise.then(files =>
- files.changes!.some(
- file =>
- file.new_file &&
- /^\.changeset\/.+\.md$/.test(file.new_path) &&
- file.new_path !== '.changeset/README.md',
- ),
- )
+const hasChangesetBeenAdded = async (
+ changedFilesPromise: ReturnType<MergeRequests['showChanges']>,
+) => {
+ const changedFiles = await changedFilesPromise
+ const changes =
+ 'changes' in changedFiles ? changedFiles.changes : changedFiles.data.changes
+ return changes.some(file => {
+ return (
+ file.new_file &&
+ /^\.changeset\/.+\.md$/.test(file.new_path) &&
+ file.new_path !== '.changeset/README.md'
+ )
+ })
+}
 
 export const comment = async () => {
  const {
@@ -168,7 +171,7 @@ export const comment = async () => {
 
  try {
  const latestCommitSha = CI_MERGE_REQUEST_SOURCE_BRANCH_SHA!
- const changedFilesPromise = api.MergeRequests.changes(
+ const changedFilesPromise = api.MergeRequests.showChanges(
  context.projectId,
  mrIid,
  )
@@ -179,7 +182,7 @@ export const comment = async () => {
  hasChangesetBeenAdded(changedFilesPromise),
  getChangedPackages({
  changedFiles: changedFilesPromise.then(x =>
- x.changes!.map(x => x.new_path),
+ x.changes.map(x => x.new_path),
  ),
  api,
  }).catch((err: unknown) => {
@@ -217,7 +220,6 @@ export const comment = async () => {
  return api.MergeRequestDiscussions.editNote(
  context.projectId,
  mrIid,
- // @ts-expect-error - https://github.com/jdalrymple/gitbeaker/pull/523#issuecomment-975276068
  noteInfo.discussionId,
  noteInfo.noteId,
  {
@@ -239,7 +241,7 @@ export const comment = async () => {
  context.projectId,
  mrIid,
  noteInfo.noteId,
- prComment,
+ { body: prComment },
  )
  }
 

src/index.ts

@@ -1,4 +1,4 @@
-import { Gitlab } from '@gitbeaker/node'
+import { Gitlab } from '@gitbeaker/rest'
 import type { ProxyAgentConfigurationType } from 'global-agent'
 import { bootstrap } from 'global-agent'
 
@@ -23,21 +23,26 @@ export const createApi = (gitlabToken?: string) => {
  }
  }
 
- const token = gitlabToken || process.env.GITLAB_TOKEN
-
- let tokenType: 'jobToken' | 'oauthToken' | 'token' = 'token'
+ const token = gitlabToken || process.env.GITLAB_TOKEN!
+ const host = process.env.GITLAB_HOST ?? process.env.CI_SERVER_URL
 
+ // we cannot use { [tokenType]: token } now
+ // because it will break the type of the Gitlab constructor
  switch (process.env.GITLAB_TOKEN_TYPE) {
  case 'job':
- tokenType = 'jobToken'
- break
+ return new Gitlab({
+ host,
+ jobToken: token,
+ })
  case 'oauth':
- tokenType = 'oauthToken'
- break
+ return new Gitlab({
+ host,
+ oauthToken: token,
+ })
+ default:
+ return new Gitlab({
+ host,
+ token,
+ })
  }
-
- return new Gitlab({
- host: process.env.GITLAB_HOST ?? process.env.CI_SERVER_URL,
- [tokenType]: token,
- })
 }

src/run.ts

@@ -41,7 +41,7 @@ const createRelease = async (
  )
  }
 
- await api.Releases.create(context.projectId, {
+ await api.ProjectReleases.create(context.projectId, {
  name: tagName,
  tag_name: tagName,
  description: changelogEntry.content,

src/utils.ts

@@ -154,8 +154,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
+export const getUsername = (api: Gitlab) => {
+ return (
+ process.env.GITLAB_CI_USER_NAME ??
+ api.Users.showCurrentUser().then(currentUser => currentUser.username)
+ )
 }