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: action.yml
+146-62
Original file line number
Diff line number
Diff line change
@@ -5,106 +5,190 @@ branding:
5
5
icon: "check-circle"
6
6
color: "green"
7
7
inputs:
8
-
thread-comments:
9
-
description: >-
10
-
Set this option to 'true' or 'false' to enable or disable the use of
11
-
thread comments as feedback. Set this to 'update' to update an existing comment
12
-
if one exists; the value 'true' will always delete an old comment and post a new one
13
-
if necessary. Defaults to false.
14
-
required: false
15
-
default: 'false'
16
-
no-lgtm:
17
-
description: >-
18
-
Set this option to true or false to enable or disable the use of a thread comment that
19
-
basically says 'Looks Good To Me' (when all checks pass). Defaults to true.
20
-
See `thread-comments` option for further details.
21
-
required: false
22
-
default: true
23
-
step-summary:
24
-
description: >
25
-
Set this option to true to append content as part of workflow's job summary. Defaults to false.
26
-
27
-
See implementation details in GitHub's documentation about
28
-
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary).
29
-
This option is independent of the `thread-comments` option, rather this option uses the same content that
30
-
the `thread-comments` option would use.
31
-
required: false
32
-
default: false
33
-
file-annotations:
34
-
description: Set this option to false to disable the use of file annotations as feedback. Defaults to true.
35
-
required: false
36
-
default: true
37
8
style:
38
-
description: >
39
-
The style rules to use (defaults to 'llvm').
40
-
Set this to 'file' to have clang-format use the closest relative .clang-format file.
9
+
description: |
10
+
The style rules to use.
11
+
12
+
- Set this to `file` to have clang-format use the closest relative .clang-format file.
13
+
- Set this to a blank string (`''`) to disable the use of clang-format entirely.
14
+
- Any code style supported by the specified version of clang-format.
41
15
required: false
42
16
default: "llvm"
43
17
extensions:
44
-
description: >
45
-
The file extensions to run the action against.
46
-
This comma-separated string defaults to 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx'.
18
+
description: The file extensions to run the action against. This is a comma-separated string.
47
19
required: false
48
20
default: "c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx"
49
21
tidy-checks:
50
-
description: >
51
-
A string of regex-like patterns specifying what checks clang-tidy will use.
52
-
This defaults to 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'. See also clang-tidy docs for more info.
22
+
description: |
23
+
Comma-separated list of globs with optional `-` prefix.
24
+
Globs are processed in order of appearance in the list.
25
+
Globs without `-` prefix add checks with matching names to the set,
26
+
globs with the `-` prefix remove checks with matching names from the set of enabled checks.
27
+
This option's value is appended to the value of the 'Checks' option in a .clang-tidy file (if any).
28
+
29
+
- It is possible to disable clang-tidy entirely by setting this option to `'-*'`.
30
+
- It is also possible to rely solely on a .clang-tidy config file by specifying this option as a blank string (`''`).
The relative path to the repository root directory. The default value '.' is relative to the runner's GITHUB_WORKSPACE environment variable.
35
+
The relative path to the repository root directory.
36
+
This path is relative to the path designated as the runner's `GITHUB_WORKSPACE` environment variable.
58
37
required: false
59
-
default: "."
38
+
default: '.'
60
39
version:
61
-
description: "The desired version of the clang tools to use. Accepted options are strings which can be 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8 or 7. Defaults to 12."
40
+
description: |
41
+
The desired version of the [clang-tools](https://github.com/cpp-linter/clang-tools-pip) to use.
42
+
Accepted options are strings which can be 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8 or 7.
43
+
44
+
- Set this option to a blank string (`''`) to use the platform's default installed version.
45
+
- This value can also be a path to where the clang tools are installed (if using a custom install location).
62
46
required: false
63
-
default: "12"
47
+
default: 12
64
48
verbosity:
65
-
description: A hidden option to control the action's log verbosity. This is the `logging` level (defaults to `info`).
49
+
description: |
50
+
This controls the action's verbosity in the workflow's logs.
51
+
Supported options are `info` or `debug`.
52
+
This option does not affect the verbosity of resulting thread comments or file annotations.
53
+
54
+
The verbosity can also be engaged by enabling debug logs when
55
+
[re-running jobs or workflows](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs).
66
56
required: false
67
57
default: info
68
58
lines-changed-only:
69
-
description: Set this option to 'true' to only analyze changes in the event's diff. Defaults to 'false'.
59
+
description: |
60
+
This controls what part of the files are analyzed. The following values are accepted:
61
+
62
+
- `false`: All lines in a file are analyzed.
63
+
- `true`: Only lines in the diff that contain additions are analyzed.
64
+
- `diff`: All lines in the diff are analyzed (including unchanged lines but not subtractions).
65
+
66
+
!!! info "Important"
67
+
This feature requires special permissions to perform successfully.
68
+
See our [documented permissions](permissions.md)
70
69
required: false
71
70
default: false
72
71
files-changed-only:
73
-
description: Set this option to 'false' to analyze any source files in the repo. Defaults to 'true'.
72
+
description: |
73
+
Set this option to false to analyze any source files in the repo.
74
+
This is automatically enabled if [`lines-changed-only`](#lines-changed-only) is enabled.
75
+
76
+
!!! info "Important"
77
+
This feature requires special permissions to perform successfully.
78
+
See our [documented permissions](permissions.md)
74
79
required: false
75
80
default: true
76
81
ignore:
77
-
description: >
82
+
description: |
78
83
Set this option with string of path(s) to ignore.
79
84
80
-
- In the case of multiple paths, you can use a pipe character ('|')
81
-
to separate the multiple paths. Multiple lines are forbidden as input to this option.
85
+
- In the case of multiple paths, you can use a pipe character (`|`)
86
+
to separate the multiple paths. Multiple lines are forbidden as an input to this option;
87
+
it must be a single string.
82
88
- This can also have files, but the file's relative path has to be specified
83
89
as well.
84
-
- There is no need to use './' for each entry; a blank string ('') represents
85
-
the repo-root path (specified by the `repo-root` input option).
86
-
- Path(s) containing a space should be inside single quotes.
87
-
- Submodules are automatically ignored.
88
-
- Prefix a path with a bang (`!`) to make it explicitly not ignored - order of
89
-
multiple paths does take precedence. The `!` prefix can be applied to
90
-
submodules if desired.
91
-
- Glob patterns are not supported here. All asterisk characters ('*') are literal.
92
-
required: false
93
-
default: ".github"
90
+
- There is no need to use `./` for each entry; a blank string (`''`) represents
91
+
the [`repo-root`](#repo-root) path.
92
+
- Submodules are automatically ignored. Hidden directories (beginning with a `.`) are also ignored
93
+
automatically.
94
+
- Prefix a path with a bang (`!`) to make it explicitly _not_ ignored. The order of
95
+
multiple paths does _not_ take precedence. The `!` prefix can be applied to
96
+
a submodule's path (if desired) but not hidden directories.
97
+
- Glob patterns are not supported here. All asterisk characters (`*`) are literal.
98
+
required: false
99
+
default: '.github'
100
+
thread-comments:
101
+
description: |
102
+
This controls the behavior of posted thread comments as feedback. The following options are supported:
103
+
104
+
- `true`: enable the use of thread comments. This will always delete an outdated thread comment and post a new comment (triggering a notification for every comment).
105
+
- `update`: update an existing thread comment if one already exists. This option does not trigger a new notification for every thread comment update.
106
+
- `false`: disable the use of thread comments.
107
+
108
+
!!! info "Important"
109
+
This feature requires special permissions to perform successfully.
110
+
See our [documented permissions](permissions.md)
111
+
112
+
> [!NOTE]
113
+
> 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.
114
+
required: false
115
+
default: 'false'
116
+
no-lgtm:
117
+
description: |
118
+
Set this option to true or false to enable or disable the use of a
119
+
thread comment or pull request review that basically says 'Looks Good To Me' (when all checks pass).
120
+
The default value, `true` means no LGTM comment posted.
121
+
122
+
See [`thread-comments`](#thread-comments), [`tidy-review`](#tidy-review),
123
+
and [`format-review`](#format-review) options for further details.
124
+
required: false
125
+
default: true
126
+
step-summary:
127
+
description: |
128
+
Set this option to true to append content as part of workflow's job summary.
129
+
130
+
See implementation details in GitHub's documentation about
131
+
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary).
132
+
This option is independent of the [`thread-comments`](#thread-comments) option,
133
+
rather this option uses the same content that the
134
+
[`thread-comments`](#thread-comments) option would use.
135
+
136
+
> [!NOTE]
137
+
> The [`no-lgtm`](#no-lgtm) option is _not_ applied to step summaries.
138
+
required: false
139
+
default: false
140
+
file-annotations:
141
+
description: |
142
+
Set this option to false to disable the use of file annotations as feedback.
143
+
required: false
144
+
default: true
94
145
database:
95
-
description: The directory containing compile_commands.json file.
146
+
description: The directory containing compilation database (like compile_commands.json) file.
96
147
required: false
97
148
default: ""
98
149
extra-args:
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.
150
+
description: |
151
+
A string of extra arguments passed to clang-tidy for use as compiler arguments.
152
+
Multiple arguments are separated by spaces so the argument name and value should
153
+
use an `=` sign instead of a space.
154
+
155
+
!!! example
156
+
157
+
``` yaml
158
+
extra-args: '-std=c++17 -Wall'
159
+
```
160
+
This will be passed to clang-tidy as multiple `--extra-arg` options:
0 commit comments