Improvements to NPM package caching across workflows (#32458)

* Use a consistent cache key for NPM packages across all workflows. Also, include the NodeJS version in the cache key in case different package versions are required. * Update the `actions/cache` action to the latest version. * Remove the strategy matrix from jobs with a single NodeJS version. For some reason, GitHub Actions will attach matrix values to job names in parenthesis. Because required checks are configured by job name, these need to stay consistent.
WordPress · Jun 7, 2021 · 7e54162 · 7e54162
1 parent 175a08f
commit 7e54162
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 81 deletions.
diff --git a/.github/workflows/build-plugin-zip.yml b/.github/workflows/build-plugin-zip.yml
@@ -112,25 +112,24 @@ jobs:
         runs-on: ubuntu-latest
         needs: bump-version
         if: always()
+
         steps:
             - name: Checkout code
               uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
               with:
                   ref: ${{ needs.bump-version.outputs.release_branch || github.ref }}
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: 14
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Build Gutenberg plugin ZIP file
               run: ./bin/build-plugin-zip.sh

diff --git a/.github/workflows/bundle-size.yml b/.github/workflows/bundle-size.yml
@@ -35,16 +35,25 @@ jobs:
     build:
         name: Check
         runs-on: ubuntu-latest
-
+        strategy:
+            matrix:
+                node: ['14']
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
               with:
                   fetch-depth: 1
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
+
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
+              with:
+                  # npm cache files are stored in `~/.npm` on Linux/macOS
+                  path: ~/.npm
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - uses: preactjs/compressed-size-action@7d87f60a6b0c7d193b8183ce859ed00b356ea92f # v2.1.0
               with:

diff --git a/.github/workflows/create-block.yml b/.github/workflows/create-block.yml
@@ -20,24 +20,22 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                node: [12, 14]
+                node: ['12', '14']
 
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js ${{ matrix.node }}.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules-${{ matrix.node }}
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: npm install, build, format and lint
               run: |

diff --git a/.github/workflows/end2end-test.yml b/.github/workflows/end2end-test.yml
@@ -24,23 +24,22 @@ jobs:
             fail-fast: false
             matrix:
                 part: [1, 2, 3, 4]
+                node: ['14']
 
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               run: |

diff --git a/.github/workflows/performance.yml b/.github/workflows/performance.yml
@@ -21,19 +21,17 @@ jobs:
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: 14
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install
               run: |

diff --git a/.github/workflows/pull-request-automation.yml b/.github/workflows/pull-request-automation.yml
@@ -8,17 +8,28 @@ jobs:
     pull-request-automation:
         runs-on: ubuntu-latest
         if: ${{ github.repository == 'WordPress/gutenberg' }}
+        strategy:
+            matrix:
+                node: ['14']
+
         steps:
             # Checkout defaults to using the branch which triggered the event, which
             # isn't necessarily `trunk` (e.g. in the case of a merge).
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
               with:
                   ref: trunk
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
+
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
+              with:
+                  # npm cache files are stored in `~/.npm` on Linux/macOS
+                  path: ~/.npm
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             # Changing into the action's directory and running `npm install` is much
             # faster than a full project-wide `npm ci`.

diff --git a/.github/workflows/rnmobile-android-runner.yml b/.github/workflows/rnmobile-android-runner.yml
@@ -19,26 +19,28 @@ jobs:
         strategy:
             matrix:
                 native-test-name: [gutenberg-editor-initial-html]
+                node: ['14']
 
         steps:
             - name: checkout
               uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
 
-            - name: Restore npm cache
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
+                  # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - run: npm ci
 
             - name: Restore Gradle cache
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   path: ~/.gradle/caches
                   key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}

diff --git a/.github/workflows/rnmobile-ios-runner.yml b/.github/workflows/rnmobile-ios-runner.yml
@@ -20,36 +20,38 @@ jobs:
             matrix:
                 xcode: [12.2]
                 native-test-name: [gutenberg-editor-initial-html]
+                node: ['14']
 
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
 
-            - name: Restore npm cache
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
+                  # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - run: npm ci
 
             - name: Prepare build cache key
               run: find package-lock.json packages/react-native-editor/ios packages/react-native-aztec/ios packages/react-native-bridge/ios -type f -print0 | sort -z | xargs -0 shasum | tee ios-checksums.txt
 
             - name: Restore build cache
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   path: |
                       packages/react-native-editor/ios/build/GutenbergDemo/Build/Products/Release-iphonesimulator/GutenbergDemo.app
                       packages/react-native-editor/ios/build/WDA
                   key: ${{ runner.os }}-ios-build-${{ matrix.xcode }}-${{ hashFiles('ios-checksums.txt') }}
 
             - name: Restore pods cache
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   path: |
                       packages/react-native-editor/ios/Pods

diff --git a/.github/workflows/static-checks.yml b/.github/workflows/static-checks.yml
@@ -24,19 +24,17 @@ jobs:
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: 14
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               # A "full" install is executed, since `npm ci` does not always exit

diff --git a/.github/workflows/storybook-pages.yml b/.github/workflows/storybook-pages.yml
@@ -9,25 +9,27 @@ jobs:
     deploy:
         runs-on: ubuntu-latest
         if: ${{ github.repository == 'WordPress/gutenberg' }}
+        strategy:
+            matrix:
+                node: ['14']
+
         steps:
             - name: Checkout
               uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
               with:
                   ref: trunk
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: ${{ matrix.node }}
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Install Dependencies
               run: npm ci

diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -26,24 +26,22 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                node: [12, 14]
+                node: ['12', '14']
 
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js ${{ matrix.node }}.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules-${{ matrix.node }}
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-${{ matrix.node }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               # It's not necessary to run the full build, since Jest can interpret
@@ -67,19 +65,17 @@ jobs:
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: 14
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               run: |
@@ -109,19 +105,17 @@ jobs:
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
-            - name: Use Node.js 14.x
+            - name: Use desired version of NodeJS
               uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
-                  node-version: 14.x
+                  node-version: 14
 
-            - name: Cache node modules
-              uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
-              env:
-                  cache-name: cache-node-modules
+            - name: Cache NPM packages
+              uses: actions/cache@c64c572235d810460d0d6876e9c705ad5002b353 # v2.1.6
               with:
                   # npm cache files are stored in `~/.npm` on Linux/macOS
                   path: ~/.npm
-                  key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+                  key: ${{ runner.os }}-node-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               # It's not necessary to run the full build, since Jest can interpret