You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-2
Original file line number
Diff line number
Diff line change
@@ -104,8 +104,9 @@ jobs:
104
104
105
105
#### `verbosity`
106
106
107
-
-**Description**: This controls the action's verbosity in the workflow's logs. Supported options are defined by the [python logging library's log levels](https://docs.python.org/3/library/logging.html#logging-levels). This option does not affect the verbosity of resulting thread comments or file annotations.
108
-
- Default: '10'
107
+
-**Description**: This controls the action's verbosity in the workflow's logs. Supported options are `info` or `debug`. This option does not affect the verbosity of resulting thread comments or file annotations.
108
+
- The verbosity can also be engaged by enabling debug logs when [re-running jobs or workflows](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs).
109
+
- Default: 'info'
109
110
110
111
#### `lines-changed-only`
111
112
@@ -174,6 +175,24 @@ jobs:
174
175
-**Description**: A string of extra arguments passed to clang-tidy for use as compiler arguments (like `-std=c++14 -Wall`).
175
176
- Default: ''
176
177
178
+
#### `tidy-review`
179
+
180
+
**Beta feature** 🚧
181
+
182
+
-**Description**: Set this option to true to enable pull request reviews from clang-tidy.
183
+
- To use Pull Request reviews, the `GITHUB_TOKEN` (provided by Github to each repository) must be declared as an environment
184
+
variable. See [Authenticating with the GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow)
185
+
- See also [the PR review feature caveats](https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html)
186
+
- Default: false
187
+
188
+
#### `format-review`
189
+
190
+
-**Description**: Set this option to true to enable pull request reviews from clang-format.
191
+
- To use Pull Request reviews, the `GITHUB_TOKEN` (provided by Github to each repository) must be declared as an environment
192
+
variable. See [Authenticating with the GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow)
193
+
- See also [the PR review feature caveats](https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html)
194
+
- Default: false
195
+
177
196
### Outputs
178
197
179
198
This action creates 3 output variables. Even if the linting checks fail for source files this action will still pass, but users' CI workflows can use this action's outputs to exit the workflow early if that is desired.
@@ -208,6 +227,18 @@ The total number of concerns raised by clang-format only.
Copy file name to clipboardExpand all lines: action.yml
+16-4
Original file line number
Diff line number
Diff line change
@@ -62,9 +62,9 @@ inputs:
62
62
required: false
63
63
default: "12"
64
64
verbosity:
65
-
description: A hidden option to control the action's log verbosity. This is the `logging` level (defaults to DEBUG).
65
+
description: A hidden option to control the action's log verbosity. This is the `logging` level (defaults to `info`).
66
66
required: false
67
-
default: "10"
67
+
default: info
68
68
lines-changed-only:
69
69
description: Set this option to 'true' to only analyze changes in the event's diff. Defaults to 'false'.
70
70
required: false
@@ -99,6 +99,14 @@ inputs:
99
99
description: A string of extra arguments passed to clang-tidy for use as compiler arguments. Multiple arguments are separated by spaces so the argument name and value should use an '=' sign instead of a space.
100
100
required: false
101
101
default: ""
102
+
tidy-review:
103
+
description: Set this to true to enable PR reviews from clang-tidy. See also https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html
104
+
required: false
105
+
default: false
106
+
format-review:
107
+
description: Set this to true to enable PR reviews from clang-format.See also https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html
108
+
required: false
109
+
default: false
102
110
outputs:
103
111
checks-failed:
104
112
description: An integer that can be used as a boolean value to indicate if any checks failed by clang-tidy and clang-format.
0 commit comments