<!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>[52179] trunk: Build/Test Tools: Cache the results of `PHP_CodeSniffer` across workflow runs.</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/52179">52179</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/52179","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-11-16 14:17:26 +0000 (Tue, 16 Nov 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: Cache the results of `PHP_CodeSniffer` across workflow runs.
When the `PHP_CodeSniffer` runs, it produces a cache file. When a cache file is present, only changed files are rescanned, making subsequent scans significantly faster.
This adds the needed steps to the corresponding GitHub Actions workflows to cache these files across runs. The cache keys include the date of the previous Monday to ensure that the cache is flushed at least weekly.
Since GitHub Action caches cannot be updated once created, the scans will take slightly longer as the week progresses and more PHP files are updated. The date within the cache key can be updated to purge twice weekly if the scan time starts to approach the current scan times.
This change also introduces a `.cache` directory for all caching files related to build/test tools.
Props johnbillion, jrf.
Fixes <a href="https://core.trac.wordpress.org/ticket/49783">#49783</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowscodingstandardsyml">trunk/.github/workflows/coding-standards.yml</a></li>
<li><a href="#trunkgithubworkflowsphpcompatibilityyml">trunk/.github/workflows/php-compatibility.yml</a></li>
<li><a href="#trunkgitignore">trunk/.gitignore</a></li>
<li><a href="#trunkphpcompatxmldist">trunk/phpcompat.xml.dist</a></li>
<li><a href="#trunkphpcsxmldist">trunk/phpcs.xml.dist</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/.cache/</li>
<li><a href="#trunkcachegitkeep">trunk/.cache/.gitkeep</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/.cache
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/.cache 2021-11-16 04:43:49 UTC (rev 52178)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/.cache 2021-11-16 14:17:26 UTC (rev 52179)
</ins><a id="trunkcache"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: trunk/.cache</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnignore"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:ignore</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+*
</ins><a id="trunkcachegitkeep"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/.cache/.gitkeep</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">Modified: trunk/.github/workflows/coding-standards.yml
===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/.github/workflows/coding-standards.yml 2021-11-16 04:43:49 UTC (rev 52178)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/.github/workflows/coding-standards.yml 2021-11-16 14:17:26 UTC (rev 52179)
</ins><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,6 +48,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # - Checks out the repository.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Sets up PHP.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs debug information.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Configures caching for PHPCS scans.
</ins><span class="cx" style="display: block; padding: 0 10px"> # - Installs Composer dependencies (use cache if possible).
</span><span class="cx" style="display: block; padding: 0 10px"> # - Make Composer packages available globally.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs PHP_CodeSniffer debug information.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,6 +76,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> php --version
</span><span class="cx" style="display: block; padding: 0 10px"> composer --version
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # This date is used to ensure that the PHPCS cache is cleared at least once every week.
+ # http://man7.org/linux/man-pages/man1/date.1.html
+ - name: "Get last Monday's date"
+ id: get-date
+ run: echo "::set-output name=date::$(/bin/date -u --date='last Mon' "+%F")"
+
+ - name: Cache PHPCS scan cache
+ uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+ with:
+ path: .cache/phpcs.json
+ key: ${{ runner.os }}-date-${{ steps.get-date.outputs.date }}-phpcs-cache-${{ hashFiles('**/composer.json') }}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> uses: ramsey/composer-install@92a7904348d4ad30236f3611e33b7f0c6f9edd70 # v1.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span></span></pre></div>
<a id="trunkgithubworkflowsphpcompatibilityyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/php-compatibility.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/php-compatibility.yml 2021-11-16 04:43:49 UTC (rev 52178)
+++ trunk/.github/workflows/php-compatibility.yml 2021-11-16 14:17:26 UTC (rev 52179)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,7 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - '**.php'
</span><span class="cx" style="display: block; padding: 0 10px"> # These files configure Composer. Changes could affect the outcome.
</span><span class="cx" style="display: block; padding: 0 10px"> - 'composer.*'
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # This file configures PHP Compatibility scanning. Changes could affect the outcome.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # This file configures PHP compatibility scanning. Changes could affect the outcome.
</ins><span class="cx" style="display: block; padding: 0 10px"> - 'phpcompat.xml.dist'
</span><span class="cx" style="display: block; padding: 0 10px"> # Changes to workflow files should always verify all workflows are successful.
</span><span class="cx" style="display: block; padding: 0 10px"> - '.github/workflows/*.yml'
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,7 +42,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # Performs the following steps:
</span><span class="cx" style="display: block; padding: 0 10px"> # - Checks out the repository.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Sets up PHP.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Logs debug information about the runner container.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Logs debug information.
+ # - Configures caching for PHP compatibility scans.
</ins><span class="cx" style="display: block; padding: 0 10px"> # - Installs Composer dependencies (use cache if possible).
</span><span class="cx" style="display: block; padding: 0 10px"> # - Make Composer packages available globally.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Logs PHP_CodeSniffer debug information.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,6 +70,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> php --version
</span><span class="cx" style="display: block; padding: 0 10px"> composer --version
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # This date is used to ensure that the PHP compatibility cache is cleared at least once every week.
+ # http://man7.org/linux/man-pages/man1/date.1.html
+ - name: "Get last Monday's date"
+ id: get-date
+ run: echo "::set-output name=date::$(/bin/date -u --date='last Mon' "+%F")"
+
+ - name: Cache PHP compatibility scan cache
+ uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+ with:
+ path: .cache/phpcompat.json
+ key: ${{ runner.os }}-date-${{ steps.get-date.outputs.date }}-phpcompat-cache-${{ hashFiles('**/composer.json') }}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> uses: ramsey/composer-install@92a7904348d4ad30236f3611e33b7f0c6f9edd70 # v1.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span></span></pre></div>
<a id="trunkgitignore"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.gitignore</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.gitignore 2021-11-16 04:43:49 UTC (rev 52178)
+++ trunk/.gitignore 2021-11-16 14:17:26 UTC (rev 52179)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,6 +10,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /phpunit.xml
</span><span class="cx" style="display: block; padding: 0 10px"> /.phpcs.xml
</span><span class="cx" style="display: block; padding: 0 10px"> /phpcs.xml
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.cache/*
</ins><span class="cx" style="display: block; padding: 0 10px"> /tests/phpunit/data/plugins/wordpress-importer
</span><span class="cx" style="display: block; padding: 0 10px"> /tests/phpunit/data/.trac-ticket-cache*
</span><span class="cx" style="display: block; padding: 0 10px"> /tests/qunit/compiled.html
</span></span></pre></div>
<a id="trunkphpcompatxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/phpcompat.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpcompat.xml.dist 2021-11-16 04:43:49 UTC (rev 52178)
+++ trunk/phpcompat.xml.dist 2021-11-16 14:17:26 UTC (rev 52179)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,7 +11,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <arg name="extensions" value="php"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <arg name="cache"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <arg name="cache" value=".cache/phpcompat.json"/>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Set the memory limit to 256M.
</span><span class="cx" style="display: block; padding: 0 10px"> For most standard PHP configurations, this means the memory limit will temporarily be raised.
</span></span></pre></div>
<a id="trunkphpcsxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/phpcs.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpcs.xml.dist 2021-11-16 04:43:49 UTC (rev 52178)
+++ trunk/phpcs.xml.dist 2021-11-16 14:17:26 UTC (rev 52179)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,7 +6,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <arg name="extensions" value="php"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <arg name="cache"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <arg name="cache" value=".cache/phpcs.json"/>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Set the memory limit to 256M.
</span><span class="cx" style="display: block; padding: 0 10px"> For most standard PHP configurations, this means the memory limit will temporarily be raised.
</span></span></pre>
</div>
</div>
</body>
</html>