fix(ci/reviewdog): Flag files with CRLF line endings #37445
+19
−1
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
When there is a file with CRLF(Windows) line endings pushed in a PR, Prettier converts them to LF. The workflow fails to suggest this change as a review comment, and the workflow doesn't fail either.
Solution
The
git diff
command doesn't consider CRLF -> LF as a change. CRLF -> LF change is not there in the diff output. Without the diff reviewdog can not make a PR comment.As a workaround, we can flag files with CRLF and ask contributors to convert CRLF to LF.
Testing
Testing has been done in OnkarRuikar#44 (comment) and corresponding workflow run is: https://github.com/OnkarRuikar/content/actions/runs/12534736823/job/34955862300?pr=44#step:12:63
/cc @yin1999