diff options
| author |  Johannes Schindelin <johannes.schindelin@gmx.de> | 2020-11-03 15:55:31 +0000 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2020-11-03 12:34:06 -0800 |
| commit | cba2504d3de3ccd6809fa2ab484c2aaeeef5379b (patch) | |
| tree | f39ce992539f70b40fcd800369453d8e3d7137d3 | |
| parent | ci: github action - add check for whitespace errors (diff) | |
| download | tgif-cba2504d3de3ccd6809fa2ab484c2aaeeef5379b.tar.xz | |
ci: make the whitespace checker more robust
In 32c83afc2c69 (ci: github action - add check for whitespace errors,
2020-09-22), we introduced a GitHub workflow that automatically checks
Pull Requests for whitespace problems.
However, when affected lines contain one or more double quote
characters, this workflow failed to attach the informative comment
because the Javascript snippet incorrectly interpreted these quotes
instead of using the `git log` output as-is.
Let's fix that.
While at it, let's `await` the result of the `createComment()` function.
Finally, we enclose the log in the comment with ```...``` to avoid
having the diff marker be misinterpreted as an enumeration bullet.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | .github/workflows/check-whitespace.yml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/.github/workflows/check-whitespace.yml b/.github/workflows/check-whitespace.yml index 9d070b9cdf..80a961716b 100644 --- a/.github/workflows/check-whitespace.yml +++ b/.github/workflows/check-whitespace.yml @@ -58,12 +58,14 @@ jobs: - name: Add Check Output as Comment uses: actions/github-script@v3 id: add-comment + env: + log: ${{ steps.check_out.outputs.checkout }} with: script: | - github.issues.createComment({ + await github.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, - body: "Whitespace errors found in workflow ${{ github.workflow }}:\n\n${{ steps.check_out.outputs.checkout }}" + body: `Whitespace errors found in workflow ${{ github.workflow }}:\n\n\`\`\`\n${process.env.log.replace(/\\n/g, "\n")}\n\`\`\`` }) if: ${{ failure() }} |