<!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>[49938] trunk/.github/workflows: Build/Test Tools: Simplify Composer package caching.</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/49938">49938</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/49938","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-01-05 19:21:50 +0000 (Tue, 05 Jan 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: Simplify Composer package caching.
This simplifies the caching of Composer dependencies in the coding standards and PHP compatibility workflows by using a published action. This combines 3 steps into 1 within these workflows.
Because the Composer implementation within the PHPUnit test workflow is a bit specialized (`composer install` is run within the Docker container), caching has been left as is in that workflow. However, the cache key has been changed to include the version of PHP being tested. This will prevent incorrect versions of dependencies being present when they are required on jobs other than PHP 8.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/50401">#50401</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="#trunkgithubworkflowsphpunittestsyml">trunk/.github/workflows/phpunit-tests.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-01-05 19:11:56 UTC (rev 49937)
+++ trunk/.github/workflows/coding-standards.yml 2021-01-05 19:21:50 UTC (rev 49938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,10 +16,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Configures caching for Composer.
</del><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Installs Composer dependencies (from cache if possible).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Installs Composer dependencies (use cache if possible).
+ # - Make Composer packages available globally.
</ins><span class="cx" style="display: block; padding: 0 10px"> # - Logs PHP_CodeSniffer debug information.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Runs PHPCS on the full codebase with warnings suppressed.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Runs PHPCS on the `tests` directory without warnings suppressed.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,20 +33,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Checkout repository
</span><span class="cx" style="display: block; padding: 0 10px"> uses: actions/checkout@v2
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - name: Get Composer cache directory
- id: composer-cache
- run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
- - name: Set up Composer caching
- uses: actions/cache@v2
- env:
- cache-name: cache-composer-dependencies
- with:
- path: ${{ steps.composer-cache.outputs.dir }}
- key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
- restore-keys: |
- ${{ runner.os }}-composer-
-
</del><span class="cx" style="display: block; padding: 0 10px"> - name: Set up PHP
</span><span class="cx" style="display: block; padding: 0 10px"> uses: shivammathur/setup-php@v2
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,10 +46,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> composer --version
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- run: |
- composer install --prefer-dist --no-suggest --no-progress --no-ansi --no-interaction
- echo "${PWD}/vendor/bin" >> $GITHUB_PATH
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: ramsey/composer-install@v1
+ with:
+ composer-options: "--no-progress --no-ansi --no-interaction"
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Make Composer packages available globally
+ run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH
+
</ins><span class="cx" style="display: block; padding: 0 10px"> - name: Log PHPCS debug information
</span><span class="cx" style="display: block; padding: 0 10px"> run: phpcs -i
</span><span class="cx" style="display: block; padding: 0 10px">
</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-01-05 19:11:56 UTC (rev 49937)
+++ trunk/.github/workflows/php-compatibility.yml 2021-01-05 19:21:50 UTC (rev 49938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,10 +17,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Configures caching for Composer.
</del><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 about the runner container.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Installs Composer dependencies (from cache if possible).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Installs Composer dependencies (use cache if possible).
+ # - Make Composer packages available globally.
</ins><span class="cx" style="display: block; padding: 0 10px"> # - Logs PHP_CodeSniffer debug information.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Runs the PHP compatibility tests.
</span><span class="cx" style="display: block; padding: 0 10px"> # - todo: Configure Slack notifications for failing scans.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,20 +33,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Checkout repository
</span><span class="cx" style="display: block; padding: 0 10px"> uses: actions/checkout@v2
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - name: Get Composer cache directory
- id: composer-cache
- run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
- - name: Set up Composer caching
- uses: actions/cache@v2
- env:
- cache-name: cache-composer-dependencies
- with:
- path: ${{ steps.composer-cache.outputs.dir }}
- key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
- restore-keys: |
- ${{ runner.os }}-composer-
-
</del><span class="cx" style="display: block; padding: 0 10px"> - name: Set up PHP
</span><span class="cx" style="display: block; padding: 0 10px"> uses: shivammathur/setup-php@v2
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,10 +46,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> composer --version
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- run: |
- composer install --prefer-dist --no-suggest --no-progress --no-ansi --no-interaction
- echo "${PWD}/vendor/bin" >> $GITHUB_PATH
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: ramsey/composer-install@v1
+ with:
+ composer-options: "--no-progress --no-ansi --no-interaction"
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Make Composer packages available globally
+ run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH
+
</ins><span class="cx" style="display: block; padding: 0 10px"> - name: Log PHPCS debug information
</span><span class="cx" style="display: block; padding: 0 10px"> run: phpcs -i
</span><span class="cx" style="display: block; padding: 0 10px">
</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-01-05 19:11:56 UTC (rev 49937)
+++ trunk/.github/workflows/phpunit-tests.yml 2021-01-05 19:21:50 UTC (rev 49938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,9 +191,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> cache-name: cache-composer-dependencies
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
</ins><span class="cx" style="display: block; padding: 0 10px"> restore-keys: |
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ${{ runner.os }}-composer-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ${{ runner.os }}-php-${{ matrix.php }}-composer-
</ins><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>
</div>
</body>
</html>