update example in README

demonstrates how to update comments (in a PR only) instead of posting new ones.
cpp-linter · Nov 11, 2023 · 2f42dd5 · 2f42dd5
1 parent 4c88006
commit 2f42dd5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -45,6 +45,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           style: file
+          # The following value will only update a single comment
+          # in a pull request's thread. Set it to false to disable the comment. # Set it to true to post a new comment (and delete the old comment).
+          thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
 
       - name: Fail fast?!
         if: steps.linter.outputs.checks-failed > 0