Migrate from Yarn to pnpm and update GitHub Actions workflows

Author: cursoragent

.github/workflows/algolia-index.yml

@@ -8,11 +8,26 @@ jobs:
     name: Update Algolia index
     runs-on: ubuntu-latest
     steps:
+      - name: Internal github app token
+        id: token
+        uses: tibdex/github-app-token@b62528385c34dbc9f38e5f4225ac829252d1ea92 # v1.8.0
+        with:
+          app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
+          private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
+
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
-        id: setup-node
         with:
-          node-version-file: 'package.json'
+          submodules: recursive
+          token: ${{ steps.token.outputs.token }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 8
+      - run: pnpm install --frozen-lockfile
       - uses: dorny/paths-filter@v3
         id: filter
         with:
@@ -40,7 +55,7 @@ jobs:
       # without introducing another dependency like ts-node or tsx for everyone else
 
       - name: Build index for user docs
-        run: yarn build && bun ./scripts/algolia.ts
+        run: pnpm build && bun ./scripts/algolia.ts
         if: steps.filter.outputs.docs == 'true'
         env:
           ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
@@ -52,7 +67,7 @@ jobs:
           NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
 
       - name: Build index for developer docs
-        run: yarn build:developer-docs && bun ./scripts/algolia.ts
+        run: pnpm build:developer-docs && bun ./scripts/algolia.ts
         if: steps.filter.outputs.dev-docs == 'true'
         env:
           ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
@@ -63,3 +78,15 @@ jobs:
           SENTRY_DSN: https://[email protected]/0
           NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
           NEXT_PUBLIC_DEVELOPER_DOCS: 1
+
+      - name: Build & Update Sentry Docs Algolia Index
+        env:
+          ALGOLIA_WRITE_API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
+        run: pnpm build && bun ./scripts/algolia.ts
+        if: github.ref == 'refs/heads/master'
+      - name: Build & Update Developer Docs Algolia Index
+        env:
+          ALGOLIA_WRITE_API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
+          NEXT_PUBLIC_DEVELOPER_DOCS: '1'
+        run: pnpm build:developer-docs && bun ./scripts/algolia.ts
+        if: github.ref == 'refs/heads/master'

.github/workflows/lint-404s.yml

@@ -10,11 +10,27 @@ jobs:
   index:
     runs-on: ubuntu-latest
     steps:
+      - name: Internal github app token
+        id: token
+        uses: tibdex/github-app-token@b62528385c34dbc9f38e5f4225ac829252d1ea92 # v1.8.0
+        with:
+          app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
+          private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
+
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
-        id: setup-node
         with:
-          node-version-file: 'package.json'
+          submodules: recursive
+          token: ${{ steps.token.outputs.token }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 8
+      - run: pnpm install --frozen-lockfile
+
       - uses: dorny/paths-filter@v3
         id: filter
         with:
@@ -29,29 +45,23 @@ jobs:
         with:
           bun-version: latest
 
-      - uses: actions/cache@v4
-        id: cache
-        with:
-          path: ${{ github.workspace }}/node_modules
-          key: node-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
-
-      - run: yarn install --frozen-lockfile
-        if: steps.cache.outputs.cache-hit != 'true'
-
-      - run: yarn build
+      # Build the app
+      - run: pnpm build
         if: steps.filter.outputs.docs == 'true'
         env:
           SENTRY_DSN: https://[email protected]/0
           NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
 
-      - run: yarn build:developer-docs
+      - run: pnpm build:developer-docs
         if: steps.filter.outputs.dev-docs == 'true'
         env:
           SENTRY_DSN: https://[email protected]/0
           NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
+          NEXT_PUBLIC_DEVELOPER_DOCS: 1
 
+      # Start the server in the background
       - name: Start Http Server
-        run: yarn start &
+        run: pnpm start &
         if: steps.filter.outputs.docs == 'true' || steps.filter.outputs.dev-docs == 'true'
         env:
           SENTRY_DSN: https://[email protected]/0

.github/workflows/sync-labels.yml

@@ -28,8 +28,10 @@ jobs:
         with:
           node-version-file: 'package.json'
 
-      - name: Install github-label-sync
-        run: yarn global add [email protected]
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 8
+      - run: pnpm add -g [email protected]
 
       - name: Run github-label-sync
         run: |

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4
 
       - name: Internal github app token
         id: token
@@ -21,26 +21,24 @@ jobs:
           app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
           private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
 
-      - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
-        id: setup-node
+      - uses: actions/setup-node@v4
         with:
-          node-version-file: 'package.json'
-
-      - uses: actions/cache@v4
-        id: cache
+          node-version: '20'
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
+      - uses: pnpm/action-setup@v4
         with:
-          path: ${{ github.workspace }}/node_modules
-          key: node-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
-      - run: yarn install --frozen-lockfile
+          version: 8
+      - run: pnpm install --frozen-lockfile
         if: steps.cache.outputs.cache-hit != 'true'
 
-      # Additional checks
-      - run: yarn lint:ts
-      - run: yarn lint:docs
+      # Linting
+      - run: pnpm lint:ts
+      - run: pnpm lint:docs
 
-      # Run automatic fixes (run prettier apart from eslint to also fix mdx files)
-      - run: yarn lint:prettier:fix
-      - run: yarn lint:eslint:fix
+      # Auto-fix formatting to reduce noise in diffs
+      - run: pnpm lint:prettier:fix
+      - run: pnpm lint:eslint:fix
 
       # Check (and error) for dirty working tree for forks
       # Reason being we need a different token to auto commit changes and
@@ -61,17 +59,15 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/[email protected]
-      - name: Set up Node
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version-file: 'package.json'
-      - uses: actions/cache@v4
-        id: cache
+          node-version: '20'
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
+      - uses: pnpm/action-setup@v4
         with:
-          path: ${{ github.workspace }}/node_modules
-          key: node-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
-      - run: yarn install --frozen-lockfile
-        if: steps.cache.outputs.cache-hit != 'true'
+          version: 8
+      - run: pnpm install --frozen-lockfile
       - name: Run Tests
-        run: yarn test
+        run: pnpm test

.gitignore

@@ -3,6 +3,7 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+pnpm-debug.log*
 
 # Runtime data
 pids
@@ -63,7 +64,7 @@ typings/
 # IDE settings
 .idea/
 
-# Yarn
+# Package manager files
 yarn-error.log
 .pnp/
 .pnp.js
@@ -72,6 +73,9 @@ yarn-error.log
 # Yarn Integrity file
 .yarn-integrity
 
+# pnpm
+.pnpm-store
+
 # wizard files are auto generated
 static/_platforms/
 

.yarnrc.yml

@@ -1,6 +1,6 @@
 develop: setup-git
 	[ -f .env.development ] || cp .env.example .env.development
-	yarn
+	pnpm install
 
 setup-git:
 ifneq (, $(shell which pre-commit))
@@ -9,7 +9,7 @@ endif
 	git config branch.autosetuprebase always
 
 test:
-	yarn test
+	pnpm test
 
 preview-api-docs:
 	bin/preview-api-docs

Makefile

@@ -5,13 +5,7 @@ This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-
 First, run the development server:
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
 pnpm dev
-# or
-bun dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

apps/changelog/README.md

@@ -12,7 +12,7 @@
     "build": "prisma generate && next build",
     "start": "next start",
     "lint": "next lint",
-    "migrate:dev": "dotenv -e .env.development -- yarn prisma migrate reset"
+    "migrate:dev": "dotenv -e .env.development -- pnpm prisma migrate reset"
   },
   "prisma": {
     "seed": "node prisma/seed/seed.mjs"
@@ -63,9 +63,5 @@
   },
   "volta": {
     "extends": "../../package.json"
-  },
-  "resolutions": {
-    "@types/react": "npm:[email protected]",
-    "@types/react-dom": "npm:[email protected]"
   }
 }

apps/changelog/package.json

@@ -11,15 +11,12 @@
     "url": "https://github.com/getsentry/sentry-docs/issues"
   },
   "private": true,
-  "workspaces": [
-    "./apps/*"
-  ],
   "scripts": {
-    "dev": "yarn enforce-redirects && concurrently \"yarn sidecar\" \"node ./src/hotReloadWatcher.mjs\" \"next dev\"",
-    "dev:developer-docs": "yarn enforce-redirects && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn dev",
-    "build:developer-docs": "yarn enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn build",
-    "build": "yarn enforce-redirects && next build",
-    "vercel:build:developer-docs": "yarn enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn build",
+    "dev": "pnpm enforce-redirects && concurrently \"pnpm sidecar\" \"node ./src/hotReloadWatcher.mjs\" \"next dev\"",
+    "dev:developer-docs": "pnpm enforce-redirects && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm dev",
+    "build:developer-docs": "pnpm enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm build",
+    "build": "pnpm enforce-redirects && next build",
+    "vercel:build:developer-docs": "pnpm enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm build",
     "start": "next start",
     "lint": "next lint",
     "lint:ts": "tsc --skipLibCheck",
@@ -28,8 +25,8 @@
     "lint:eslint:fix": "eslint --fix \"{src,app,scripts}/**/*.{ts,tsx,js,jsx}\"",
     "lint:prettier": "prettier --check \"./{src,app,scripts}/**/*.{md,mdx,ts,tsx,js,jsx,mjs}\"",
     "lint:prettier:fix": "prettier --write \"./{src,app,scripts}/**/*.{md,mdx,ts,tsx,js,jsx,mjs}\"",
-    "lint:fix": "yarn run lint:prettier:fix && yarn run lint:eslint:fix",
-    "sidecar": "yarn spotlight-sidecar",
+    "lint:fix": "pnpm run lint:prettier:fix && pnpm run lint:eslint:fix",
+    "sidecar": "pnpm spotlight-sidecar",
     "test": "vitest",
     "test:ci": "vitest run",
     "enforce-redirects": "node ./scripts/no-vercel-json-redirects.mjs"
@@ -133,8 +130,15 @@
     "dompurify": "3.2.4",
     "@types/dompurify": "3.0.5"
   },
+  "pnpm": {
+    "overrides": {
+      "dompurify": "3.2.4",
+      "@types/dompurify": "3.0.5",
+      "@types/react": "npm:[email protected]",
+      "@types/react-dom": "npm:[email protected]"
+    }
+  },
   "volta": {
-    "node": "20.11.0",
-    "yarn": "1.22.22"
+    "node": "20.11.0"
   }
 }