feat: Add file-annotations option (#59)

* add file-annotations option

* Update docs and images (#57)

* Update docs and images
* Update display size

* Update docs and images (#57)

* adjust examples in README

* add file-annotations option

* adjust examples in README

Co-authored-by: Peter Shen <[email protected]>

Author: 2bndy5

README.md

@@ -26,10 +26,9 @@ The content of the file should be in the following format.
 name: cpp-linter
 
 on:
-  push:
-    paths-ignore: "docs/**"
   pull_request:
-    paths-ignore: "docs/**"
+    types: [opened, reopened]  # let PR-synchronize events be handled by push events
+  push:
 
 jobs:
   cpp-linter:
@@ -119,6 +118,11 @@ jobs:
 - Default: false
 - NOTE: If run on a private repository, then this feature is disabled because the GitHub REST API behaves differently for thread comments on a private repository.
 
+#### `file-annotations`
+
+- **Description**: Set this option to false to disable the use of file annotations as feedback.
+- Default: true
+
 #### `database`
 
 - **Description**: The directory containing compilation database (like compile_commands.json) file.
@@ -140,10 +144,9 @@ to install a certain version of clang-tidy and clang-format.
 
 ```yml
 on:
-  push:
-    paths-ignore: "docs/**"
   pull_request:
-    paths-ignore: "docs/**"
+    types: [opened, reopened]  # let PR-synchronize events be handled by push events
+  push:
 
 jobs:
   cpp-linter:

action.yml

@@ -6,9 +6,13 @@ branding:
   color: "green"
 inputs:
   thread-comments:
-    description: Set this option to false to disable the use of thread comments as feedback. Defaults to true.
+    description: Set this option to false to disable the use of thread comments as feedback. Defaults to false.
     required: false
     default: false
+  file-annotations:
+    description: Set this option to false to disable the use of file annotations as feedback. Defaults to true.
+    required: false
+    default: true
   style:
     description: >
       The style rules to use (defaults to 'llvm').
@@ -88,3 +92,4 @@ runs:
     - --thread-comments=${{ inputs.thread-comments }}
     - --ignore=${{ inputs.ignore }}
     - --database=${{ inputs.database }}
+    - --file-annotations=${{ inputs.file-annotations }}

cpp_linter/run.py

@@ -134,6 +134,14 @@
     help="Set this option to false to disable the use of thread comments as feedback."
     "Defaults to %(default)s.",
 )
+cli_arg_parser.add_argument(
+    "-a",
+    "--file-annotations",
+    default="true",
+    type=lambda input: input.lower() == "true",
+    help="Set this option to false to disable the use of file annotations as feedback."
+    "Defaults to %(default)s.",
+)
 
 
 def set_exit_code(override: int = None) -> int:
@@ -695,7 +703,7 @@ def post_results(use_diff_comments: bool, user_id: int = 41898282):
     set_exit_code(1 if checks_passed else 0)
 
 
-def make_annotations(style: str) -> bool:
+def make_annotations(style: str, file_annotations: bool) -> bool:
     """Use github log commands to make annotations from clang-format and
     clang-tidy output.
 
@@ -709,11 +717,13 @@ def make_annotations(style: str) -> bool:
     for note in GlobalParser.format_advice:
         if note.replaced_lines:
             ret_val = True
-            log_commander.info(note.log_command(style))
+            if file_annotations:
+                log_commander.info(note.log_command(style))
             count += 1
     for note in GlobalParser.tidy_notes:
         ret_val = True
-        log_commander.info(note.log_command())
+        if file_annotations:
+            log_commander.info(note.log_command())
         count += 1
     logger.info("Created %d annotations", count)
     return ret_val
@@ -818,7 +828,7 @@ def main():
         )
     if args.thread_comments and thread_comments_allowed:
         post_results(False)  # False is hard-coded to disable diff comments.
-    set_exit_code(int(make_annotations(args.style)))
+    set_exit_code(int(make_annotations(args.style, args.file_annotations)))
     end_log_group()