Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#62221 Fix the previous conclusion value #8176

Closed
wants to merge 1 commit into from

Conversation

johnbillion
Copy link
Member

@johnbillion johnbillion commented Jan 22, 2025

Why is this needed?

The output of the previous-attempt-result job is a JSON encoded string because actions/github-script encodes output as JSON by default. This means the output is a string wrapped in double quotes, for example: "first-failure".

This can be seen in a workflow run that has debugging enabled, for example this workflow run:

##[debug]Set output result = "failure"

Compare that to a job that uses actions/github-script to return an object:

##[debug]Set output payload = {"workflow_name":"Upgrade Tests" ...

Prior to r59679 this was fine because the value was echoed to an output which means its surrounding double quotes lost their significance:

echo "previous_conclusion=${{ steps.previous-attempt-result.outputs.result }}" >> $GITHUB_OUTPUT

The change in r59679 means the return value of the previous-attempt-result job is used directly in the previous_conclusion output, thus retaining its surrounding double quotes. Conditions in subsequent jobs such as if: ${{ needs.prepare.outputs.previous_conclusion != 'first-failure' are now broken because the previous_conclusion value is unexpectedly wrapped in double quotes and therefore don't match the conditions as expected.

This change fixes that so the conditions for the Slack notification jobs now work as expected again.

Trac ticket: https://core.trac.wordpress.org/ticket/62221

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@johnbillion johnbillion marked this pull request as ready for review January 23, 2025 12:30
Copy link

github-actions bot commented Jan 23, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props johnbillion, swissspidy, desrosj.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@@ -64,6 +64,7 @@ jobs:
with:
retries: 2
retry-exempt-status-codes: 418
result-encoding: string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL 👍

Copy link
Contributor

@desrosj desrosj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @johnbillion! Great sleuthing.

@johnbillion johnbillion changed the title #82221 Fix the previous conclusion value #62221 Fix the previous conclusion value Jan 23, 2025
@johnbillion
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants