Optimise CI to reduce runners usage, caching NPM modules when needed

.github/actions/npm-setup/action.yml

@@ -0,0 +1,39 @@
+name: 'NPM Setup'
+description: 'Sets up Node.js and installs NPM dependencies with caching'
+
+inputs:
+  runner:
+    description: 'Runner to use'
+    required: true
+  node-version:
+    description: 'Node.js version to use'
+    required: true
+  workspace:
+    description: 'Key for the cache'
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+      - name: Install NodeJS ${{ inputs.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node-version }}
+      - uses: actions/cache/restore@v4
+        id: npm-cache
+        with:
+          path: node_modules
+          key: ${{ github.head_ref || 'main' }}-${{ inputs.runner }}-node-${{ inputs.node-version }}-${{ inputs.workspace }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ github.head_ref || 'main' }}-${{ inputs.runner }}-node-${{ inputs.node-version }}-${{ inputs.workspace }}-
+      - name: Install dependencies
+        if: steps.npm-cache.outputs.cache-hit != 'true'
+        shell: bash
+        run: npm ci --omit=optional
+      - name: Cache npm
+        id: cache-npm-save
+        if: steps.npm-cache.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+          path: node_modules
+          key: ${{ steps.npm-cache.outputs.cache-primary-key }}

.github/workflows/lint.yml

@@ -14,7 +14,11 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: 22.x
-    - name: Install dependencies
-      run: npm ci --omit=optional
+    - name: Install Node and Dependencies
+      uses: ./.github/actions/npm-setup
+      with:
+        runner: ubuntu-22.04
+        node-version: 22.x
+        workspace: "packages/testcontainers"
     - name: Code linting
       run: npm run lint:ci

.github/workflows/test-template.yml

@@ -130,13 +130,12 @@ jobs:
       - name: Code checkout
         uses: actions/checkout@v4
 
-      - name: Install NodeJS ${{ inputs.node-version }}
-        uses: actions/setup-node@v4
+      - name: Install Node ${{ inputs.node-version }} and Dependencies
+        uses: ./.github/actions/npm-setup
         with:
+          runner: ${{ inputs.runner }}
           node-version: ${{ inputs.node-version }}
-
-      - name: Install dependencies
-        run: npm ci --omit=optional
+          workspace: "${{ inputs.workspace }}"
 
       - name: Run tests
         run: npm run test:ci -- ${{ inputs.workspace }}

.github/workflows/test.yml

@@ -29,12 +29,15 @@ jobs:
     steps:
       - name: Code checkout
         uses: actions/checkout@v4
-      - name: Install NodeJS ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+
+      # Uses a composite action for a consistent NPM install including cache
+      - name: Install Node ${{ matrix.node-version }} and Dependencies
+        uses: ./.github/actions/npm-setup
         with:
+          runner: ${{ matrix.runner }}
           node-version: ${{ matrix.node-version }}
-      - name: Install dependencies
-        run: npm ci --omit=optional
+          workspace: "packages/testcontainers"
+
       - name: Build workspaces
         run: npm run build -ws
       - name: Remove dev dependencies