<!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>[57210] trunk/.github/workflows: Build/Test Tools: Post message for testing on Playground only after build succeeds.</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/57210">57210</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/57210","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-12-20 14:50:11 +0000 (Wed, 20 Dec 2023)</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: Post message for testing on Playground only after build succeeds.
Uses the `workflow_run` trigger to only leave pull request comments after the build jobs finish.
Props zieladam, desrosj.
See <a href="https://core.trac.wordpress.org/ticket/59416">#59416</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowspullrequestcommentsyml">trunk/.github/workflows/pull-request-comments.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="trunkgithubworkflowspullrequestcommentsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/pull-request-comments.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/pull-request-comments.yml 2023-12-20 12:34:34 UTC (rev 57209)
+++ trunk/.github/workflows/pull-request-comments.yml 2023-12-20 14:50:11 UTC (rev 57210)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,8 +4,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> on:
</span><span class="cx" style="display: block; padding: 0 10px"> pull_request_target:
</span><span class="cx" style="display: block; padding: 0 10px"> types: [ 'opened' ]
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- branches:
- - trunk
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ workflow_run:
+ workflows: [ 'Test Build Processes' ]
+ types:
+ - completed
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Cancels all previous workflow runs for pull requests that have not completed.
</span><span class="cx" style="display: block; padding: 0 10px"> concurrency:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,7 +29,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> timeout-minutes: 5
</span><span class="cx" style="display: block; padding: 0 10px"> if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request_target' }}
</span><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - uses: wow-actions/welcome@72817eb31cda1de60f51893d80e2e82ce57f7e76 # v1.3.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Post a welcome comment
+ uses: wow-actions/welcome@72817eb31cda1de60f51893d80e2e82ce57f7e76 # v1.3.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> FIRST_PR_REACTIONS: 'hooray'
</span><span class="cx" style="display: block; padding: 0 10px"> FIRST_PR_COMMENT: >
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,17 +84,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> permissions:
</span><span class="cx" style="display: block; padding: 0 10px"> issues: write
</span><span class="cx" style="display: block; padding: 0 10px"> pull-requests: write
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request_target' }}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: >
+ github.repository == 'WordPress/wordpress-develop' &&
+ github.event.workflow_run.event == 'pull_request' &&
+ github.event.workflow_run.conclusion == 'success'
</ins><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Download artifact
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> script: |
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const artifacts = await github.rest.actions.listWorkflowRunArtifacts( {
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: ${{ github.event.workflow_run.id }},
+ } );
+
+ const matchArtifact = artifacts.data.artifacts.filter( ( artifact ) => {
+ return artifact.name === 'pr-number'
+ } )[0];
+
+ if ( ! matchArtifact ) {
+ core.setFailed( 'No artifact found!' );
+ return;
+ }
+
+ const download = await github.rest.actions.downloadArtifact( {
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ artifact_id: matchArtifact.id,
+ archive_format: 'zip',
+ } );
+
+ const fs = require( 'fs' );
+ fs.writeFileSync( '${{github.workspace}}/pr-number.zip', Buffer.from( download.data ) )
+
+ - name: Unzip the artifact containing the PR number
+ run: unzip pr-number.zip
+
+ - name: Leave a comment about testing with Playground
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+ with:
+ script: |
+ const fs = require( 'fs' );
+ const issue_number = Number( fs.readFileSync( './NR' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Comments are only added after the first successful build. Check for the presence of a comment and bail early.
</span><span class="cx" style="display: block; padding: 0 10px"> const commentInfo = {
</span><span class="cx" style="display: block; padding: 0 10px"> owner: context.repo.owner,
</span><span class="cx" style="display: block; padding: 0 10px"> repo: context.repo.repo,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- issue_number: ${{ github.event.number }}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ issue_number,
</ins><span class="cx" style="display: block; padding: 0 10px"> };
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> const comments = ( await github.rest.issues.listComments( commentInfo ) ).data;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> for ( const currentComment of comments ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -116,7 +159,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> For more details about these limitations and more, check out the [Limitations page](https://wordpress.github.io/wordpress-playground/limitations/) in the WordPress Playground documentation.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- [Test this pull request with WordPress Playground](https://playground.wordpress.net/wordpress.html?pr=${{ github.event.number }}).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ [Test this pull request with WordPress Playground](https://playground.wordpress.net/wordpress.html?pr=${ issue_number }).
</ins><span class="cx" style="display: block; padding: 0 10px"> `;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> github.rest.issues.createComment( commentInfo );
</span></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 2023-12-20 12:34:34 UTC (rev 57209)
+++ trunk/.github/workflows/test-build-processes.yml 2023-12-20 14:50:11 UTC (rev 57210)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,7 +106,29 @@
</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><ins style="background-color: #dfd; 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' }}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+ with:
+ name: pr-number
+ path: pr-number/
+
</ins><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>