feat: enable cache in CI

TICKET: WP-6096

Author: zahin-mohammad

.github/workflows/ci.yml

@@ -14,6 +14,9 @@ permissions:
   contents: read
   pull-requests: read
 
+env:
+  NX_NO_CLOUD: true
+
 jobs:
   unit-test:
     runs-on: ubuntu-latest
@@ -63,16 +66,31 @@ jobs:
       - name: Check In-Repo Package Versions
         run: yarn run check-versions
 
+      - name: restore nx cache
+        id: nx-cache
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 #v4.2.3
+        if: "!contains( github.event.pull_request.labels.*.name, 'SKIP_CACHE')"
+        with:
+          path: |
+            .nx/cache
+            modules/*/dist
+          key: ${{ runner.os }}-nx-${{ matrix.node-version }}-${{ hashFiles('yarn.lock') }}-${{ hashFiles('modules/*/src/**/*.ts', 'modules/*/src/**/*.js', 'modules/*/*.json', '!modules/*/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-nx-${{ matrix.node-version }}-${{ hashFiles('yarn.lock') }}-
+            ${{ runner.os }}-nx-${{ matrix.node-version }}-
+
       - name: build packages
         env:
           # Workaround for https://github.com/nodejs/node/issues/51555
           DISABLE_V8_COMPILE_CACHE: '1'
+          NX_SKIP_NX_CACHE: ${{ contains(github.event.pull_request.labels.*.name, 'SKIP_CACHE') && 'true' || '' }}
         run: yarn run postinstall
 
       - name: Unit Test
         run: yarn run unit-test-changed
         env:
           BITGOJS_TEST_PASSWORD: ${{ secrets.BITGOJS_TEST_PASSWORD }}
+          NX_SKIP_NX_CACHE: ${{ contains(github.event.pull_request.labels.*.name, 'SKIP_CACHE') && 'true' || '' }}
 
       # - name: Upload Code Coverage
       #   run: |
@@ -158,10 +176,24 @@ jobs:
         if: steps.lerna-cache.outputs.cache-hit != 'true'
         run: yarn install --with-frozen-lockfile --ignore-scripts
 
+      - name: restore nx cache
+        id: nx-cache
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 #v4.2.3
+        if: "!contains( github.event.pull_request.labels.*.name, 'SKIP_CACHE')"
+        with:
+          path: |
+            .nx/cache
+            modules/*/dist
+          key: ${{ runner.os }}-nx-license-${{ hashFiles('yarn.lock') }}-${{ hashFiles('modules/*/src/**/*.ts', 'modules/*/src/**/*.js', 'modules/*/*.json', '!modules/*/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-nx-license-${{ hashFiles('yarn.lock') }}-
+            ${{ runner.os }}-nx-license-
+
       - name: build packages
         env:
           # Workaround for https://github.com/nodejs/node/issues/51555
           DISABLE_V8_COMPILE_CACHE: '1'
+          NX_SKIP_NX_CACHE: ${{ contains(github.event.pull_request.labels.*.name, 'SKIP_CACHE') && 'true' || '' }}
         run: yarn run postinstall
 
       - name: Run Fossa Analysis
@@ -251,6 +283,19 @@ jobs:
         if: steps.lerna-cache.outputs.cache-hit != 'true' || contains( github.event.pull_request.labels.*.name, 'SKIP_CACHE')
         run: yarn install --with-frozen-lockfile
 
+      - name: restore nx cache
+        id: nx-cache
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 #v4.2.3
+        if: "!contains( github.event.pull_request.labels.*.name, 'SKIP_CACHE')"
+        with:
+          path: |
+            .nx/cache
+            modules/*/dist
+          key: ${{ runner.os }}-nx-browser-${{ hashFiles('yarn.lock') }}-${{ hashFiles('modules/*/src/**/*.ts', 'modules/*/src/**/*.js', 'modules/*/*.json', '!modules/*/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-nx-browser-${{ hashFiles('yarn.lock') }}-
+            ${{ runner.os }}-nx-browser-
+
       - name: build packages
         if: steps.lerna-cache.outputs.cache-hit == 'true'
         env:
@@ -262,6 +307,7 @@ jobs:
         run: yarn run browser-tests
         env:
           BITGOJS_TEST_PASSWORD: ${{ secrets.BITGOJS_TEST_PASSWORD }}
+          NX_SKIP_NX_CACHE: ${{ contains(github.event.pull_request.labels.*.name, 'SKIP_CACHE') && 'true' || '' }}
 
   docker-build:
     runs-on: ubuntu-latest

CLAUDE.md

@@ -79,18 +79,37 @@ The cache automatically invalidates when:
 - Dependencies change
 - Configuration files change (tsconfig.json, .mocharc.*, package.json)
 
-**Note for CI**: Nx caching requires proper dependency management. Tests depend on build outputs, so ensure packages are built before running tests. The `yarn postinstall` step must run even when node_modules are cached.
-
-If you encounter TypeScript module resolution errors in CI, you can disable Nx caching by:
+### CI Caching
+
+BitGoJS CI uses both GitHub Actions cache and Nx cache for optimal performance:
+
+**GitHub Actions Cache**:
+- Caches `node_modules` and `modules/*/node_modules`
+- Caches `.nx/cache` and `modules/*/dist` directories
+- Cache keys include source file hashes for proper invalidation
+
+**Nx Cache**:
+- Automatically enabled in CI (via `useNx: true` in lerna.json)
+- Caches build outputs and test results
+- Respects task dependencies (tests depend on builds)
+
+**Skipping Cache**:
+- Add the `SKIP_CACHE` label to a PR to bypass all caching
+- This forces fresh installs and builds
+- When `SKIP_CACHE` is used:
+  - GitHub Actions cache is not restored
+  - Nx caching is disabled (`NX_SKIP_NX_CACHE=true`)
+  - All tasks run fresh without any caching
+
+**Troubleshooting**:
+If you encounter module resolution errors in CI:
 ```bash
 # Option 1: Use --skip-nx-cache flag
 yarn unit-test --skip-nx-cache
 
-# Option 2: Set environment variable
-NX_SKIP_NX_CACHE=true yarn unit-test
-
-# Option 3: Temporarily disable in lerna.json
-# Set "useNx": false
+# Option 2: Clear cache and rebuild
+yarn clean-cache
+yarn build
 ```
 
 ### Browser Compatibility