<!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>[53108] trunk/.github/workflows/slack-notifications.yml: Build/Test Tools: Improve the accuracy of {U+201C}fixed{U+201D} Slack notifications.</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/53108">53108</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/53108","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>2022-04-08 13:57:44 +0000 (Fri, 08 Apr 2022)</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: Improve the accuracy of {U+201C}fixed{U+201D} Slack notifications.
This adjusts the logic of the Slack Notifications workflow to make the {U+201C}fixed{U+201D} notifications more reliable.
Currently, the workflow looks at the immediately preceding workflow run for the current branch. This fails to indicate that a workflow is fixed when other unrelated commits are made, and when rerunning the workflow after a false failure (timeout, etc.).
The workflow will now use the following logic to determine if something has been fixed:
- When a workflow is rerun, the conclusion for the immediately preceding run attempt will now be used to determine if the current attempt has {U+201C}fixed{U+201D} the workflow.
- When on the first run attempt for a workflow run, the workflow conclusion for the immediately preceding commit will be used.
- When on the first run attempt for a workflow run and no preceding commits for the current branch are present (this is a fresh tag or branch), always consider it {U+201C}fixed{U+201D}.
Props davidbaumwald.
See <a href="https://core.trac.wordpress.org/ticket/54742">#54742</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowsslacknotificationsyml">trunk/.github/workflows/slack-notifications.yml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowsslacknotificationsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/slack-notifications.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/slack-notifications.yml 2022-04-08 06:34:21 UTC (rev 53107)
+++ trunk/.github/workflows/slack-notifications.yml 2022-04-08 13:57:44 UTC (rev 53108)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,9 +52,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> # submit data to Slack webhook URLs configured to post messages.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- # - Retrieves the workflow ID (if necessary).
- # - Retrieves the workflow URL (if necessary).
- # - Retrieves the previous workflow run and stores its conclusion.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ # - Retrieves the current workflow run.
+ # - Determine the conclusion of the previous workflow run or run attempt.
</ins><span class="cx" style="display: block; padding: 0 10px"> # - Sets the previous conclusion as an output.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Prepares the commit message.
</span><span class="cx" style="display: block; padding: 0 10px"> # - Constructs and stores a message payload as an output.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,10 +67,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> payload: ${{ steps.create-payload.outputs.payload }}
</span><span class="cx" style="display: block; padding: 0 10px">
</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">- - name: Get the workflow ID
- id: current-workflow-id
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Determine the status of the previous attempt
+ id: previous-attempt-result
</ins><span class="cx" style="display: block; padding: 0 10px"> if: ${{ github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' }}
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: actions/github-script@441359b1a30438de65712c2fbca0abe4816fa667 # v5.0.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: actions/github-script@9ac08808f993958e9de277fe43a64532a609130e # v6.0.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> script: |
</span><span class="cx" style="display: block; padding: 0 10px"> const workflow_run = await github.rest.actions.getWorkflowRun({
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,36 +78,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> repo: context.repo.repo,
</span><span class="cx" style="display: block; padding: 0 10px"> run_id: ${{ github.run_id }},
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return workflow_run.data.workflow_id;
</del><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 details about the previous workflow run
- id: previous-result
- uses: actions/github-script@441359b1a30438de65712c2fbca0abe4816fa667 # v5.0.0
- with:
- script: |
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // When a workflow has been restarted to fix a failure, check the previous run attempt.
+ if ( workflow_run.data.run_attempt > 1 ) {
+ const previous_run = await github.rest.actions.getWorkflowRunAttempt({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ run_id: ${{ github.run_id }},
+ attempt_number: workflow_run.data.run_attempt - 1
+ });
+
+ return previous_run.data.conclusion;
+ }
+
+ let workflow_id = '';
+ if ( ${{ github.event_name == 'workflow_run' }} ) {
+ workflow_id = '${{ github.event.workflow_run.workflow_id }}';
+ } else {
+ workflow_id = workflow_run.data.workflow_id;
+ }
+
+ // Otherwise, check the previous workflow run.
</ins><span class="cx" style="display: block; padding: 0 10px"> const previous_runs = await github.rest.actions.listWorkflowRuns({
</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">- workflow_id: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.workflow_id || steps.current-workflow-id.outputs.result }},
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ workflow_id: workflow_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> branch: '${{ env.CURRENT_BRANCH }}',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- per_page: 1,
- page: 2,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ exclude_pull_requests: true,
</ins><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( previous_runs.data.total_count > 0 ) {
- return previous_runs.data.workflow_runs[0].conclusion;
- } else {
- // Use failure so all first time runs for a branch or tag are reported to Slack.
- return 'failure';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This is the first workflow run for this branch or tag.
+ if ( previous_runs.data.workflow_runs.length == 0 ) {
+ return 'none';
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Find the workflow run for the commit that immediately preceded this one.
+ for ( let i = 0; i < previous_runs.data.workflow_runs.length; i++ ) {
+ if ( previous_runs.data.workflow_runs[ i ].run_number == workflow_run.data.run_number ) {
+ return previous_runs.data.workflow_runs[ i + 1 ].conclusion;
+ }
+ }
+
+ // Can't determine previous workflow conclusion.
+ return 'unknown';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> - name: Store previous conclusion as an output
</span><span class="cx" style="display: block; padding: 0 10px"> id: previous-conclusion
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- run: echo "::set-output name=previous_conclusion::${{ steps.previous-result.outputs.result }}"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ run: echo "::set-output name=previous_conclusion::${{ steps.previous-attempt-result.outputs.result }}"
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Get the commit message
</span><span class="cx" style="display: block; padding: 0 10px"> id: current-commit-message
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: actions/github-script@441359b1a30438de65712c2fbca0abe4816fa667 # v5.0.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: actions/github-script@9ac08808f993958e9de277fe43a64532a609130e # v6.0.0
</ins><span class="cx" style="display: block; padding: 0 10px"> if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> script: |
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,7 +162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Post failure notifications to Slack
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: slackapi/slack-github-action@410ae57cff5c6b682b106440be0e6c7eb8c98c9d # v1.16.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: slackapi/slack-github-action@16b6c78ee73689a627b65332b34e5d409c7299da # v1.18.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> payload: ${{ needs.prepare.outputs.payload }}
</span><span class="cx" style="display: block; padding: 0 10px"> env:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,11 +174,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> runs-on: ubuntu-latest
</span><span class="cx" style="display: block; padding: 0 10px"> timeout-minutes: 5
</span><span class="cx" style="display: block; padding: 0 10px"> needs: [ prepare ]
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ needs.prepare.outputs.previous_conclusion == 'failure' && ( github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' || inputs.calling_status == 'success' ) && success() }}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: ${{ contains( fromJson( '["failure", "cancelled", "none"]' ), needs.prepare.outputs.previous_conclusion ) && ( github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' || inputs.calling_status == 'success' ) && success() }}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Post failure notifications to Slack
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: slackapi/slack-github-action@410ae57cff5c6b682b106440be0e6c7eb8c98c9d # v1.16.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: slackapi/slack-github-action@16b6c78ee73689a627b65332b34e5d409c7299da # v1.18.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> payload: ${{ needs.prepare.outputs.payload }}
</span><span class="cx" style="display: block; padding: 0 10px"> env:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,7 +194,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Post success notifications to Slack
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: slackapi/slack-github-action@410ae57cff5c6b682b106440be0e6c7eb8c98c9d # v1.16.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: slackapi/slack-github-action@16b6c78ee73689a627b65332b34e5d409c7299da # v1.18.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> payload: ${{ needs.prepare.outputs.payload }}
</span><span class="cx" style="display: block; padding: 0 10px"> env:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -190,7 +210,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> steps:
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Post cancelled notifications to Slack
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: slackapi/slack-github-action@410ae57cff5c6b682b106440be0e6c7eb8c98c9d # v1.16.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: slackapi/slack-github-action@16b6c78ee73689a627b65332b34e5d409c7299da # v1.18.0
</ins><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> payload: ${{ needs.prepare.outputs.payload }}
</span><span class="cx" style="display: block; padding: 0 10px"> env:
</span></span></pre>
</div>
</div>
</body>
</html>