Changeset 50436 for trunk

Timestamp:

02/25/2021 08:47:28 PM (4 years ago)

Author:

desrosj

Message:

Build/Test Tools: Prevent the NPM/Composer caches in GitHub Actions from snowballing.

The actions/cache GitHub action uses a key input to find the desired cache in storage. Currently, this is defined as a combination of the operating system being used, the software being cached (NPM or Composer), PHP version (Composer only), and a hash of the relevant lock file.

The cache action also supports a restore-keys input, which is an ordered list of keys to use for restoring a cache if no cache hit occurred for the specified key.

However, this means that every time a lock file is updated, the cache is being recreated by first restoring a previous one (when available), and then installing new versions of dependencies on top of that. This results in old, unused versions of dependencies never being removed from the cache.

In this change, the restore-keys are removed. This will force a new, fresh cache to be generated when the desired key is not matched. In testing, this results in a ~40% reduction in cache size when compared to the latest successful workflow runs. Since there is no way to manually flush the cache in GHA, the benefits of this change will not be seen until the package-lock.json and composer.lock files are updated, or the cache at the desired key is evicted.

Props johbillion.
See #52660.

Location:

trunk/.github/workflows

Files:

• coding-standards.yml (modified) (1 diff)
• end-to-end-tests.yml (modified) (1 diff)
• javascript-tests.yml (modified) (1 diff)
• phpunit-tests.yml (modified) (3 diffs)
• test-coverage.yml (modified) (1 diff)
• verify-npm-on-windows.yml (modified) (1 diff)

trunk/.github/workflows/coding-standards.yml

@@ -115 +115 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Log debug information

trunk/.github/workflows/end-to-end-tests.yml

@@ -83 +83 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Install Dependencies

trunk/.github/workflows/javascript-tests.yml

@@ -65 +65 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Log debug information

trunk/.github/workflows/phpunit-tests.yml

@@ -81 +81 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Install Dependencies
@@ -187 +185 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Install Dependencies
@@ -206 +202 @@
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-php-${{ matrix.php }}-composer-
 
       - name: Install Composer dependencies

trunk/.github/workflows/test-coverage.yml

@@ -82 +82 @@
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Install Dependencies

trunk/.github/workflows/verify-npm-on-windows.yml

@@ -66 +66 @@
           path: ${{ steps.npm-cache.outputs.dir }}
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
 
       - name: Install Dependencies