<!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>[58274] trunk/.github/workflows: Build/Test Tools: Make the logic around Playground testing reusable.</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/58274">58274</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/58274","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>2024-05-31 18:11:30 +0000 (Fri, 31 May 2024)</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: Make the logic around Playground testing reusable.
The workflow responsible for testing the build process is currently responsible for creating a ZIP file of the WordPress build and storing it as an artifact. This can be used for manual testing, but is mainly used for spinning up a Playground instance.
Because of how comments with Playground testing instructions are left pull requests. the pull request number needs to be stored as a workflow artifact as well. This moves the logic responsible for this to the reusable workflow, which allows older branches to make use of Playground testing without additional maintenance burden.
See <a href="https://core.trac.wordpress.org/ticket/59416">#59416</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowsreusabletestcorebuildprocessyml">trunk/.github/workflows/reusable-test-core-build-process.yml</a></li>
<li><a href="#trunkgithubworkflowstestbuildprocessesyml">trunk/.github/workflows/test-build-processes.yml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowsreusabletestcorebuildprocessyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/reusable-test-core-build-process.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/reusable-test-core-build-process.yml 2024-05-31 18:08:56 UTC (rev 58273)
+++ trunk/.github/workflows/reusable-test-core-build-process.yml 2024-05-31 18:11:30 UTC (rev 58274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,6 +21,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> required: false
</span><span class="cx" style="display: block; padding: 0 10px"> type: 'boolean'
</span><span class="cx" style="display: block; padding: 0 10px"> default: true
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ prepare-playground:
+ description: 'Whether to prepare the artifacts needed for Playground testing.'
+ required: false
+ type: 'boolean'
+ default: false
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> env:
</span><span class="cx" style="display: block; padding: 0 10px"> PUPPETEER_SKIP_DOWNLOAD: ${{ true }}
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +44,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # - Cleans up after building WordPress.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Ensures version-controlled files are not modified or deleted.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Uploads the ZIP as a GitHub Actions artifact (when building to the build directory).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Saves the pull request number to a text file.
+ # - Uploads the pull request number as an artifact.
</ins><span class="cx" style="display: block; padding: 0 10px"> build-process-tests:
</span><span class="cx" style="display: block; padding: 0 10px"> name: Core running from ${{ inputs.directory }} / ${{ inputs.os == 'macos-latest' && 'MacOS' || inputs.os == 'windows-latest' && 'Windows' || 'Linux' }}
</span><span class="cx" style="display: block; padding: 0 10px"> runs-on: ${{ inputs.os }}
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,8 +97,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Upload ZIP as a GitHub Actions artifact
</span><span class="cx" style="display: block; padding: 0 10px"> uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ inputs.directory == 'build' && 'ubuntu-latest' == inputs.os }}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: ${{ inputs.prepare-playground }}
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> name: wordpress-build-${{ github.event_name == 'pull_request' && github.event.number || github.sha }}
</span><span class="cx" style="display: block; padding: 0 10px"> path: wordpress.zip
</span><span class="cx" style="display: block; padding: 0 10px"> if-no-files-found: error
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ - name: Save PR number
+ if: ${{ inputs.prepare-playground && github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
+ run: |
+ mkdir -p ./pr-number
+ echo ${{ github.event.number }} > ./pr-number/NR
+
+ # Uploads the PR number as an artifact for the Pull Request Commenting workflow to download and then
+ # leave a comment detailing how to test the PR within WordPress Playground.
+ - name: Upload PR number as artifact
+ uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
+ if: ${{ inputs.prepare-playground && github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
+ with:
+ name: pr-number
+ path: pr-number/
</ins></span></pre></div>
<a id="trunkgithubworkflowstestbuildprocessesyml"></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-build-processes.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/test-build-processes.yml 2024-05-31 18:08:56 UTC (rev 58273)
+++ trunk/.github/workflows/test-build-processes.yml 2024-05-31 18:11:30 UTC (rev 58274)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,9 +40,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> matrix:
</span><span class="cx" style="display: block; padding: 0 10px"> os: [ ubuntu-latest, windows-latest ]
</span><span class="cx" style="display: block; padding: 0 10px"> directory: [ 'src', 'build' ]
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ include:
+ # Only prepare artifacts for Playground once.
+ - os: ubuntu-latest
+ directory: 'build'
+ prepare-playground: true
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> os: ${{ matrix.os }}
</span><span class="cx" style="display: block; padding: 0 10px"> directory: ${{ matrix.directory }}
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ prepare-playground: ${{ matrix.prepare-playground && matrix.prepare-playground || false }}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Tests the WordPress Core build process on MacOS.
</span><span class="cx" style="display: block; padding: 0 10px"> #
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,29 +112,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> os: ${{ matrix.os }}
</span><span class="cx" style="display: block; padding: 0 10px"> directory: ${{ matrix.directory }}
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # Uploads the PR number as an artifact for the Pull Request Commenting workflow to download and then
- # leave a comment detailing how to test the PR within WordPress Playground.
- playground-comment:
- name: Leave WordPress Playground details
- runs-on: ubuntu-latest
- permissions:
- actions: write
- continue-on-error: true
- needs: [ test-core-build-process, test-core-build-process-macos, test-gutenberg-build-process, test-gutenberg-build-process-macos ]
- if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request' }}
-
- steps:
- - name: Save PR number
- run: |
- mkdir -p ./pr-number
- echo ${{ github.event.number }} > ./pr-number/NR
-
- - name: Upload PR number as artifact
- uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
- with:
- name: pr-number
- path: pr-number/
-
</del><span class="cx" style="display: block; padding: 0 10px"> slack-notifications:
</span><span class="cx" style="display: block; padding: 0 10px"> name: Slack Notifications
</span><span class="cx" style="display: block; padding: 0 10px"> uses: WordPress/wordpress-develop/.github/workflows/slack-notifications.yml@trunk
</span></span></pre>
</div>
</div>
</body>
</html>