fix(ci): improve logging in the reviewdog workflow #37292
Merged
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.
Summary
At the moment, it is hard to figure out what went wrong when the reviewdog workflow fails to post comments on a PR.
Solution
When the workflow fails, dump the
prettier—-check
logs. Also, provide the Prettier playground link so driveby GitHub online contributors can format files without setting up a local dev environment.Note: The PR also adds words used in workflows to the cSpell ignore list.
Testing
The code has been tested in:
The new logs look like as follows: