ci: Update to pnpm for faster CI/CD and local development workflow

Author: Quenty

.github/workflows/build.yml

@@ -1,5 +1,11 @@
 name: build
 on: [push]
+
+permissions:
+  contents: write        # Create releases and tags
+  pull-requests: write   # Comment on PRs with release info
+  packages: write        # Publish to GitHub Packages
+
 jobs:
   build-linting:
     uses: ./.github/workflows/linting.yml
@@ -16,28 +22,14 @@ jobs:
           persist-credentials: false # https://stackoverflow.com/questions/74744498/github-pushing-to-protected-branches-with-fine-grained-token
 
       - name: Setup node
-        uses: actions/setup-node@v2
-        env:
-          NPM_TOKEN: '' # https://github.com/JS-DevTools/npm-publish/issues/15
+        uses: actions/setup-node@v6
         with:
-          cache-dependency-path: package.json # we don't have a package-lock.json so we'll use this instead...
-          node-version: '18'
-
-      - name: Run `npm install --no-package-lock --no-fund` on cli-output-helpers
-        run: npm install --no-package-lock --no-fund
-        working-directory: tools/cli-output-helpers
+          node-version: '21'
 
-      - name: Build cli-output-helpers
-        run: npm run build
-        working-directory: tools/cli-output-helpers
-
-      - name: Run `npm install --no-package-lock --no-fund` on nevermore-template-helpers
-        run: npm install --no-package-lock  --no-fund
-        working-directory: tools/nevermore-template-helpers
-
-      - name: Build nevermore-template-helpers
-        run: npm run build
-        working-directory: tools/nevermore-template-helpers
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          cache: true
 
       - name: Setup npm for GitHub Packages
         run: |
@@ -49,23 +41,18 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Run `npm install --no-package-lock` on nevermore-cli
-        run: npm install --no-package-lock
-        working-directory: tools/nevermore-cli
-
-      - name: Build nevermore-cli
-        run: npm run build
-        working-directory: tools/nevermore-cli
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
-      - name: Run npm install
-        run: npm install --no-save --no-fund
+      - name: Build all tools
+        run: pnpm -r --filter './tools/**' run build
 
       - name: Git reset .npmrc
         run: git checkout .npmrc
 
       - name: Create Release
         env:
-          GITHUB_TOKEN: ${{ secrets.NEVERMORE_CI_PAT }}
+          GITHUB_TOKEN: ${{ github.ref == 'refs/heads/main' && secrets.NEVERMORE_CI_PAT || secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx auto shipit
 

.github/workflows/docs.yml

@@ -9,10 +9,11 @@ jobs:
     name: Build and deploy docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-node@v2
+      - name: Setup node
+        uses: actions/setup-node@v6
         with:
-          node-version: '18'
+          node-version: '21'
+
       - run: npm i -g moonwave@latest
       - name: Publish
         run: |

.github/workflows/linting.yml

@@ -12,6 +12,12 @@ jobs:
         with:
           version: 'v0.3.0'
           token: ${{ secrets.GITHUB_TOKEN }}
+          cache: true
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          cache: true
 
       - name: Setup npm for GitHub Packages
         run: |
@@ -23,37 +29,16 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Run `npm install --no-package-lock` on cli-output-helpers
-        run: npm install --no-package-lock --no-fund
-        working-directory: tools/cli-output-helpers
-
-      - name: Build cli-output-helpers
-        run: npm run build
-        working-directory: tools/cli-output-helpers
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
 
-      - name: Run `npm install --no-package-lockd` on nevermore-template-helpers
-        run: npm install --no-package-lock --no-fund
-        working-directory: tools/nevermore-template-helpers
-
-      - name: Build nevermore-template-helpers
-        run: npm run build
-        working-directory: tools/nevermore-template-helpers
-
-      - name: Run `npm install --no-package-lock` on nevermore-cli
-        run: npm install --no-package-lock --no-fund
-        working-directory: tools/nevermore-cli
-
-      - name: Build nevermore-cli
-        run: npm run build
-        working-directory: tools/nevermore-cli
+      - name: Build all tools
+        run: pnpm -r --filter './tools/**' --filter '!./tools/nevermore-vscode' run build
 
       - name: Install nevermore-cli locally
         run: npm install -g .
         working-directory: tools/nevermore-cli
 
-      - name: Link and install packages
-        run: npm run build:link
-
       - name: Generate Sourcemap
         run: npm run build:sourcemap
 
@@ -71,6 +56,7 @@ jobs:
         with:
           version: 'v0.3.0'
           token: ${{ secrets.GITHUB_TOKEN }}
+          cache: true
 
       - name: stylua check
         run: npm run lint:stylua
@@ -86,6 +72,7 @@ jobs:
         with:
           version: 'v0.3.0'
           token: ${{ secrets.GITHUB_TOKEN }}
+          cache: true
 
       - name: selene check
         run: npm run lint:selene
@@ -101,6 +88,7 @@ jobs:
         with:
           version: 'v0.3.0'
           token: ${{ secrets.GITHUB_TOKEN }}
+          cache: true
 
       - name: Run moonwave-extractor
         run: npm run lint:moonwave

.github/workflows/tests.yml

@@ -10,15 +10,14 @@ jobs:
           fetch-depth: 0
 
       - name: Setup node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v6
         with:
-          cache-dependency-path: package.json
-          node-version: '18'
+          node-version: '21'
 
-      - name: Install GitHub CLI
-        run: |
-          sudo apt update
-          sudo apt install gh -y
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          cache: true
 
       - name: Setup npm for GitHub Packages
         run: |
@@ -30,10 +29,11 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Install package dependencies
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Compute changed packages
         run: |
-          echo "Installing package dependencies..."
-          npx lerna exec -- npm install --no-audit --no-fund
           PACKAGES=$(npx lerna ls --since origin/main --json | jq -r '.[] | select(.name != "@quenty/nevermore-cli") | .location' | tr '\n' ' ')
           echo "PACKAGES=$PACKAGES" >> $GITHUB_ENV
 
@@ -46,15 +46,16 @@ jobs:
           echo "Installing changed packages..."
           npm i ${{ env.PACKAGES }}
 
-          echo "Installing Jest"
-          npm i https://github.com/quentystudios/jest-lua.git
+          echo "Installing Jest..."
+          pnpm add https://github.com/quentystudios/jest-lua.git
 
       - name: Setup Aftman
         uses: ok-nick/setup-aftman@v0.4.2
         with:
           path: tests/bin
           version: 'v0.3.0'
           token: ${{ secrets.GITHUB_TOKEN }}
+          cache: true
 
       - name: Generate test place file
         run: rojo build default.project.json -o testBuild.rbxl

.gitignore

@@ -12,9 +12,8 @@ dist
 .DS_Store
 globalTypes.d.lua
 *.vsix
+tests/bin
 
 # Normally it's a good idea to commit this. However, in this mono-repo scenario with linking
-# it adds a ton of noise and no real gain. Also we have seen no gains from reproducing
-# builds so we don't have a strict need for this right now.
-package-lock.json
-tests/bin
+# it adds a ton of noise and no real gain. Instead, we rely upon pnpm-lock.yaml which is less messy.
+package-lock.json

.npmrc

@@ -1 +0,0 @@
-package-lock = false

lerna.json

@@ -1,12 +1,8 @@
 {
-  "packages": [
-    "src/*",
-    "tools/*"
-  ],
+  "npmClient": "pnpm",
+  "packages": ["src/*", "tools/*"],
   "command": {
-    "publish": {
-      "verifyAccess": false
-    },
+    "publish": {},
     "version": {
       "conventionalCommits": true,
       "createRelease": "github",

package.json

@@ -1,29 +1,30 @@
 {
   "name": "@quenty/nevermore",
   "private": true,
+  "packageManager": "pnpm@10.27.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/Quenty/NevermoreEngine.git"
   },
   "devDependencies": {
-    "@auto-it/all-contributors": "^v11.0.4",
-    "@auto-it/conventional-commits": "^v11.0.4",
-    "@auto-it/first-time-contributor": "^v11.0.4",
-    "@auto-it/npm": "^v11.0.4",
-    "@auto-it/released": "^v11.0.4",
-    "auto": "^v11.0.4",
-    "lerna": "^7.1.4",
-    "moonwave": "^1.1.2"
+    "@auto-it/all-contributors": "^v11.3.6",
+    "@auto-it/conventional-commits": "^v11.3.6",
+    "@auto-it/first-time-contributor": "^v11.3.6",
+    "@auto-it/npm": "^v11.3.6",
+    "@auto-it/released": "^v11.3.6",
+    "auto": "^v11.3.6",
+    "lerna": "^9.0.3",
+    "moonwave": "^1.3.0",
+    "pnpm": "^10.27.0"
   },
   "scripts": {
-    "build:link": "npx lerna exec --parallel -- npm install --no-package-lock --no-audit --no-fund",
+    "build:link": "pnpm install",
     "build:sourcemap": "rojo sourcemap default.project.json --output sourcemap.json --absolute",
     "format": "stylua --config-path=stylua.toml src games tests plugins",
     "lint:luau": "luau-lsp analyze --sourcemap=sourcemap.json --base-luaurc=.luaurc --defs=globalTypes.d.lua --flag:LuauSolverV2=false --ignore=**/node_modules/** --ignore=**/*.story.lua --ignore=**/*.client.lua --ignore=**/*.server.lua src",
     "lint:moonwave": "npx lerna exec --parallel -- moonwave-extractor extract src",
     "lint:selene": "npx lerna exec --parallel -- selene --no-summary --num-threads=1 --config=../../selene.toml src",
     "lint:stylua": "stylua --config-path=stylua.toml --check src games tests plugins",
-    "postinstall": "npm run build:link",
     "prelint:luau": "npm run build:sourcemap && npx @quenty/nevermore-cli download-roblox-types",
     "prelint:selene": "selene generate-roblox-std",
     "release": "auto shipit"