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 · Jul 7, 2021 · 747d471 · 747d471
1 parent 26987e6
commit 747d471
Show file tree

Hide file tree

Showing 11 changed files with 116 additions and 50 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
@@ -38,20 +38,24 @@ jobs:
         strategy:
             matrix:
                 node: ['14']
-
         steps:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
               with:
                   fetch-depth: 1
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
-                  cache: npm
 
-            - uses: preactjs/compressed-size-action@df6e03e187079aef959a2878311639c77b95ee2e # v2.2.0
+            - 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:
                   repo-token: '${{ secrets.GITHUB_TOKEN }}'
-                  pattern: '{build/**/*.min.js,build/**/*.css}'
-                  clean-script: 'distclean'
+                  pattern: '{build/**/*.js,build/**/*.css}'
diff --git a/.github/workflows/create-block.yml b/.github/workflows/create-block.yml
@@ -26,10 +26,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
-                  cache: npm
+
+            - 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') }}
 
             - name: npm install, build, format and lint
               run: |

diff --git a/.github/workflows/end2end-test.yml b/.github/workflows/end2end-test.yml
@@ -31,10 +31,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
-                  cache: npm
+
+            - 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') }}
 
             - name: Npm install and build
               run: |

diff --git a/.github/workflows/performance.yml b/.github/workflows/performance.yml
@@ -23,10 +23,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: 14
-                  cache: npm
+
+            - 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-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
@@ -9,17 +9,28 @@ jobs:
         timeout-minutes: 10
         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
@@ -22,26 +22,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
@@ -29,10 +29,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
-                  cache: npm
+
+            - 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') }}
 
             - run: npm ci
 
@@ -73,9 +79,7 @@ jobs:
               run: TEST_RN_PLATFORM=ios npm run native device-tests:local  ${{ matrix.native-test-name }}
 
             - name: Prepare build cache
-              run: |
-                  rm packages/react-native-editor/ios/build/GutenbergDemo/Build/Products/Release-iphonesimulator/GutenbergDemo.app/main.jsbundle
-                  rm -rf packages/react-native-editor/ios/build/GutenbergDemo/Build/Products/Release-iphonesimulator/GutenbergDemo.app/assets
+              run: rm packages/react-native-editor/ios/build/GutenbergDemo/Build/Products/Release-iphonesimulator/GutenbergDemo.app/main.jsbundle
 
             - uses: actions/upload-artifact@e448a9b857ee2131e752b06002bf0e093c65e571 # v2.2.2
               if: always()

diff --git a/.github/workflows/static-checks.yml b/.github/workflows/static-checks.yml
@@ -25,25 +25,33 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: 14
-                  cache: npm
 
-            - name: Npm install
+            - 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-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
+
+            - name: Npm install and build
               # A "full" install is executed, since `npm ci` does not always exit
               # with an error status code if the lock file is inaccurate.
               #
               # See: https://github.com/WordPress/gutenberg/issues/16157
-              run: npm install
+              run: |
+                  npm install
+                  npm run build
 
             - name: Lint JavaScript and Styles
               run: npm run lint
 
             - name: Type checking
               run: npm run build:package-types
 
-            - name: Check local changes
+            - name: Build artifacts
               run: npm run check-local-changes
 
             - name: License compatibility

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
@@ -32,10 +32,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: ${{ matrix.node }}
-                  cache: npm
+
+            - 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') }}
 
             - name: Npm install and build
               # It's not necessary to run the full build, since Jest can interpret
@@ -60,10 +66,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: 14
-                  cache: npm
+
+            - 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-14-npm-cache-${{ hashFiles('**/package-lock.json') }}
 
             - name: Npm install and build
               run: |
@@ -94,10 +106,16 @@ jobs:
             - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f # v2.3.4
 
             - name: Use desired version of NodeJS
-              uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f # v2.2.2
+              uses: actions/setup-node@46071b5c7a2e0c34e49c3cb8a0e792e86e18d5ea # v2.1.5
               with:
                   node-version: 14
-                  cache: npm
+
+            - 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-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