CCM-16068 - Added support for setting up pnpm tooling

Author: rhyscoxnhs

.github/actions/build-docs/action.yml

@@ -9,12 +9,17 @@ runs:
   steps:
     - name: Checkout
       uses: actions/checkout@v6.0.2
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        version: 10.33.0
     - uses: actions/setup-node@v4
       with:
         node-version-file: '.tool-versions'
-    - name: Npm cli install
+        cache: 'pnpm'
+    - name: pnpm install
       working-directory: ./docs
-      run: npm ci --min-release-age 3
+      run: pnpm install --frozen-lockfile
       shell: bash
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1.180.1

.github/actions/node-install/action.yaml

@@ -1,5 +1,5 @@
-name: 'npm install and setup'
-description: 'Setup node, authenticate github package repository and perform clean npm install'
+name: 'pnpm install and setup'
+description: 'Setup node, authenticate github package repository and perform clean pnpm install'
 
 inputs:
   GITHUB_TOKEN:
@@ -9,16 +9,22 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    - name: 'Setup pnpm'
+      uses: pnpm/action-setup@v4
+      with:
+        version: 10.33.0
+
     - name: 'Use Node.js'
       uses: actions/setup-node@v4
       with:
         node-version-file: '.tool-versions'
         registry-url: 'https://npm.pkg.github.com'
         scope: '@nhsdigital'
+        cache: 'pnpm'
 
     - name: 'Install dependencies'
       shell: bash
       env:
         NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
       run: |
-        npm ci --min-release-age 3
+        pnpm install --frozen-lockfile

.github/dependabot.yaml

@@ -16,7 +16,7 @@ updates:
     cooldown:
       default-days: 7
 
-  - package-ecosystem: "npm"
+  - package-ecosystem: "pnpm"
     directory: "/"
     schedule:
       interval: "daily"

.github/workflows/stage-2-test.yaml

@@ -48,16 +48,21 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v6.0.2
+      - name: "Setup pnpm"
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.33.0
       - name: "Use Node.js"
         uses: actions/setup-node@v4
         with:
           node-version-file: '.tool-versions'
+          cache: 'pnpm'
       - name: "Repo setup"
         run: |
-          npm ci --min-release-age 3
+          pnpm install --frozen-lockfile
       - name: "Generate dependencies"
         run: |
-          npm run generate-dependencies --workspaces --if-present
+          pnpm run generate-dependencies
           git diff --exit-code
   test-unit:
     name: "Unit tests"
@@ -66,16 +71,21 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v6.0.2
+      - name: "Setup pnpm"
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.33.0
       - name: "Use Node.js"
         uses: actions/setup-node@v4
         with:
           node-version-file: '.tool-versions'
+          cache: 'pnpm'
       - name: "Repo setup"
         run: |
-          npm ci --min-release-age 3
+          pnpm install --frozen-lockfile
       - name: "Generate dependencies"
         run: |
-          npm run generate-dependencies --workspaces --if-present
+          pnpm run generate-dependencies
       - name: "Run unit test suite"
         run: |
           make test-unit
@@ -98,16 +108,21 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v6.0.2
+      - name: "Setup pnpm"
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.33.0
       - name: "Use Node.js"
         uses: actions/setup-node@v4
         with:
           node-version-file: '.tool-versions'
+          cache: 'pnpm'
       - name: "Repo setup"
         run: |
-          npm ci --min-release-age 3
+          pnpm install --frozen-lockfile
       - name: "Generate dependencies"
         run: |
-          npm run generate-dependencies --workspaces --if-present
+          pnpm run generate-dependencies
       - name: "Run linting"
         run: |
           make test-lint
@@ -118,16 +133,21 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v6.0.2
+      - name: "Setup pnpm"
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10.33.0
       - name: "Use Node.js"
         uses: actions/setup-node@v4
         with:
           node-version-file: '.tool-versions'
+          cache: 'pnpm'
       - name: "Repo setup"
         run: |
-          npm ci --min-release-age 3
+          pnpm install --frozen-lockfile
       - name: "Generate dependencies"
         run: |
-          npm run generate-dependencies --workspaces --if-present
+          pnpm run generate-dependencies
       - name: "Run typecheck"
         run: |
           make test-typecheck

.npmrc

@@ -2,6 +2,7 @@ act            0.2.64
 gitleaks       8.24.0
 jq             1.6
 nodejs         24.14.1
+pnpm           10.33.0
 pre-commit     3.6.0
 ruby           3.3.6
 terraform      1.10.1

.tool-versions

@@ -11,7 +11,7 @@
     ".github": false,
     ".vscode": false
   },
-  "jest.jestCommandLine": "npm run test:unit --workspaces --",
+  "jest.jestCommandLine": "pnpm run --recursive test:unit --",
   "sonarlint.connectedMode.project": {
     "connectionId": "nhsdigital",
     "projectKey": "NHSDigital_nhs-notify-client-callbacks"

.vscode/settings.json

@@ -8,7 +8,7 @@ include scripts/init.mk
 # Example CI/CD targets are: dependencies, build, clean, etc.
 
 dependencies: # Install dependencies needed to build and test the project @Pipeline
-	npm ci
+	pnpm install --frozen-lockfile
 
 build: # Build the project artefact @Pipeline
 	(cd docs && make build)

Makefile

@@ -8,7 +8,7 @@ h help:
 	@egrep '^\S|^$$' Makefile
 
 install:
-	npm install
+	pnpm install
 	bundle config set --local path vendor/bundle
 	bundle install
 

docs/Makefile

@@ -1,7 +1,7 @@
 {
   "author": "",
   "dependencies": {
-    "nhsuk-frontend": "^8.1.1"
+    "nhsuk-frontend": "catalog:app"
   },
   "description": "",
   "devDependencies": {},