<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[50436] trunk/.github/workflows: Build/Test Tools: Prevent the NPM/Composer caches in GitHub Actions from snowballing.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/50436">50436</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/50436","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-02-25 20:47:28 +0000 (Thu, 25 Feb 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/52660">#52660</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowscodingstandardsyml">trunk/.github/workflows/coding-standards.yml</a></li>
<li><a href="#trunkgithubworkflowsendtoendtestsyml">trunk/.github/workflows/end-to-end-tests.yml</a></li>
<li><a href="#trunkgithubworkflowsjavascripttestsyml">trunk/.github/workflows/javascript-tests.yml</a></li>
<li><a href="#trunkgithubworkflowsphpunittestsyml">trunk/.github/workflows/phpunit-tests.yml</a></li>
<li><a href="#trunkgithubworkflowstestcoverageyml">trunk/.github/workflows/test-coverage.yml</a></li>
<li><a href="#trunkgithubworkflowsverifynpmonwindowsyml">trunk/.github/workflows/verify-npm-on-windows.yml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowscodingstandardsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/coding-standards.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/coding-standards.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/coding-standards.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,8 +114,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Log debug information
</span><span class="cx" style="display: block; padding: 0 10px"> run: |
</span></span></pre></div>
<a id="trunkgithubworkflowsendtoendtestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/end-to-end-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/end-to-end-tests.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/end-to-end-tests.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -82,8 +82,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> run: npx install-changed --install-command="npm ci"
</span></span></pre></div>
<a id="trunkgithubworkflowsjavascripttestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/javascript-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/javascript-tests.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/javascript-tests.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,8 +64,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Log debug information
</span><span class="cx" style="display: block; padding: 0 10px"> run: |
</span></span></pre></div>
<a id="trunkgithubworkflowsphpunittestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/phpunit-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/phpunit-tests.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/phpunit-tests.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,8 +80,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> run: npx install-changed --install-command="npm ci"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,8 +184,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> run: npx install-changed --install-command="npm ci"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,8 +201,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> path: ${{ steps.composer-cache.outputs.dir }}
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-php-${{ matrix.php }}-composer-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> if: ${{ env.COMPOSER_INSTALL == true || env.LOCAL_PHP == '8.0-fpm' }}
</span></span></pre></div>
<a id="trunkgithubworkflowstestcoverageyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/test-coverage.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/test-coverage.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/test-coverage.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,8 +81,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # npm cache files are stored in `~/.npm` on Linux/macOS
</span><span class="cx" style="display: block; padding: 0 10px"> path: ~/.npm
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> run: npx install-changed --install-command="npm ci"
</span></span></pre></div>
<a id="trunkgithubworkflowsverifynpmonwindowsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/verify-npm-on-windows.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/verify-npm-on-windows.yml 2021-02-25 14:03:16 UTC (rev 50435)
+++ trunk/.github/workflows/verify-npm-on-windows.yml 2021-02-25 20:47:28 UTC (rev 50436)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,8 +65,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> path: ${{ steps.npm-cache.outputs.dir }}
</span><span class="cx" style="display: block; padding: 0 10px"> key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- restore-keys: |
- ${{ runner.os }}-npm-
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> run: npx install-changed --install-command="npm ci"
</span></span></pre>
</div>
</div>
</body>
</html>