Wrap PR and discussion titles in toJSON
to escape them in Slack
#3699
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes
Fixes an issue where quotes in a PR title would cause the Slack messaging to fail. This is due to the way the formatting was changed in #3577.
Example: https://github.com/WordPress/openverse/actions/runs/7616428574/job/20743158171?pr=3689
Description
GitHub Actions Expressions do not allow string substitution, only concatenation and formatting1. Thus there's no easy way to replace the single or double quote characters in a PR title when interpolating them into the payload body. I am hoping that
toJSON
will appropriately escape those characters, but I have no idea if this will work!Testing Instructions
Merge and find out, maybe?
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin
Footnotes
https://docs.github.com/en/actions/learn-github-actions/expressions#functions ↩