Skip to content

Commit 1423120

Browse files
shenxianpengshenxianpeng
authored
Revert "generate inputs-outputs doc (#210)" (#215)
This reverts commit b5db5b1.
1 parent 960660a commit 1423120

File tree

6 files changed

+290
-253
lines changed

6 files changed

+290
-253
lines changed

‎action.yml

+62-172
Original file line numberDiff line numberDiff line change
@@ -5,228 +5,118 @@ branding:
55
icon: "check-circle"
66
color: "green"
77
inputs:
8-
style:
9-
description: |
10-
The style rules to use.
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.
1126
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.
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+
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.
1541
required: false
1642
default: "llvm"
17-
minimum-version: '1.2.0'
1843
extensions:
19-
description: The file extensions to run the action against. This is a comma-separated string.
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'.
2047
required: false
2148
default: "c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx"
22-
minimum-version: '1.2.0'
2349
tidy-checks:
24-
description: |
25-
Comma-separated list of globs with optional `-` prefix.
26-
Globs are processed in order of appearance in the list.
27-
Globs without `-` prefix add checks with matching names to the set,
28-
globs with the `-` prefix remove checks with matching names from the set of enabled checks.
29-
This option's value is appended to the value of the 'Checks' option in a .clang-tidy file (if any).
30-
31-
- It is possible to disable clang-tidy entirely by setting this option to `'-*'`.
32-
- It is also possible to rely solely on a .clang-tidy config file by specifying this option as a blank string (`''`).
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.
3353
required: false
3454
default: "boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*"
35-
minimum-version: '1.2.0'
3655
repo-root:
3756
description: >
38-
The relative path to the repository root directory.
39-
This path is relative to the path designated as the runner's `GITHUB_WORKSPACE` environment variable.
57+
The relative path to the repository root directory. The default value '.' is relative to the runner's GITHUB_WORKSPACE environment variable.
4058
required: false
41-
default: '.'
42-
minimum-version: '1.2.0'
59+
default: "."
4360
version:
44-
description: |
45-
The desired version of the [clang-tools](https://github.com/cpp-linter/clang-tools-pip) to use.
46-
Accepted options are strings which can be 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8 or 7.
47-
48-
- Set this option to a blank string (`''`) to use the platform's default installed version.
49-
- This value can also be a path to where the clang tools are installed (if using a custom install location).
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."
5062
required: false
51-
default: 12
52-
minimum-version: '1.2.0'
63+
default: "12"
5364
verbosity:
54-
description: |
55-
This controls the action's verbosity in the workflow's logs.
56-
Supported options are `info` or `debug`.
57-
This option does not affect the verbosity of resulting thread comments or file annotations.
58-
59-
The verbosity can also be engaged by enabling debug logs when
60-
[re-running jobs or workflows](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs).
65+
description: A hidden option to control the action's log verbosity. This is the `logging` level (defaults to `info`).
6166
required: false
6267
default: info
63-
minimum-version: '1.3.0'
6468
lines-changed-only:
65-
description: |
66-
This controls what part of the files are analyzed. The following values are accepted:
67-
68-
- `false`: All lines in a file are analyzed.
69-
- `true`: Only lines in the diff that contain additions are analyzed.
70-
- `diff`: All lines in the diff are analyzed (including unchanged lines but not subtractions).
71-
72-
!!! info "Important"
73-
This feature requires special permissions to perform successfully.
74-
See our [documented permissions](permissions.md)
69+
description: Set this option to 'true' to only analyze changes in the event's diff. Defaults to 'false'.
7570
required: false
7671
default: false
77-
minimum-version: '1.5.0'
78-
required-permission: 'content: read #file-changes'
7972
files-changed-only:
80-
description: |
81-
Set this option to false to analyze any source files in the repo.
82-
This is automatically enabled if [`lines-changed-only`](#lines-changed-only) is enabled.
83-
84-
!!! info "Important"
85-
This feature requires special permissions to perform successfully.
86-
See our [documented permissions](permissions.md)
73+
description: Set this option to 'false' to analyze any source files in the repo. Defaults to 'true'.
8774
required: false
8875
default: true
89-
minimum-version: '1.3.0'
90-
required-permission: 'content: read #file-changes'
9176
ignore:
92-
description: |
77+
description: >
9378
Set this option with string of path(s) to ignore.
9479
95-
- In the case of multiple paths, you can use a pipe character (`|`)
96-
to separate the multiple paths. Multiple lines are forbidden as an input to this option;
97-
it must be a single string.
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.
9882
- This can also have files, but the file's relative path has to be specified
9983
as well.
100-
- There is no need to use `./` for each entry; a blank string (`''`) represents
101-
the [`repo-root`](#repo-root) path.
102-
- Submodules are automatically ignored. Hidden directories (beginning with a `.`) are also ignored
103-
automatically.
104-
- Prefix a path with a bang (`!`) to make it explicitly _not_ ignored. The order of
105-
multiple paths does _not_ take precedence. The `!` prefix can be applied to
106-
a submodule's path (if desired) but not hidden directories.
107-
- Glob patterns are not supported here. All asterisk characters (`*`) are literal.
108-
required: false
109-
default: '.github'
110-
minimum-version: '1.3.0'
111-
thread-comments:
112-
description: |
113-
This controls the behavior of posted thread comments as feedback. The following options are supported:
114-
115-
- `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).
116-
- `update`: update an existing thread comment if one already exists. This option does not trigger a new notification for every thread comment update.
117-
- `false`: disable the use of thread comments.
118-
119-
!!! info "Important"
120-
This feature requires special permissions to perform successfully.
121-
See our [documented permissions](permissions.md)
122-
123-
> [!NOTE]
124-
> 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.
125-
required: false
126-
default: 'false'
127-
minimum-version: '2.6.2'
128-
required-permission: 'issues: write #thread-comments'
129-
no-lgtm:
130-
description: |
131-
Set this option to true or false to enable or disable the use of a
132-
thread comment or pull request review that basically says 'Looks Good To Me' (when all checks pass).
133-
The default value, `true` means no LGTM comment posted.
134-
135-
See [`thread-comments`](#thread-comments), [`tidy-review`](#tidy-review),
136-
and [`format-review`](#format-review) options for further details.
137-
required: false
138-
default: true
139-
minimum-version: '2.6.2'
140-
step-summary:
141-
description: |
142-
Set this option to true to append content as part of workflow's job summary.
143-
144-
See implementation details in GitHub's documentation about
145-
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary).
146-
This option is independent of the [`thread-comments`](#thread-comments) option,
147-
rather this option uses the same content that the
148-
[`thread-comments`](#thread-comments) option would use.
149-
150-
> [!NOTE]
151-
> The [`no-lgtm`](#no-lgtm) option is _not_ applied to step summaries.
152-
required: false
153-
default: false
154-
minimum-version: '2.6.0'
155-
file-annotations:
156-
description: |
157-
Set this option to false to disable the use of file annotations as feedback.
158-
required: false
159-
default: true
160-
minimum-version: '1.4.3'
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"
16194
database:
162-
description: The directory containing compilation database (like compile_commands.json) file.
95+
description: The directory containing compile_commands.json file.
16396
required: false
16497
default: ""
165-
minimum-version: '1.4.0'
16698
extra-args:
167-
description: |
168-
A string of extra arguments passed to clang-tidy for use as compiler arguments.
169-
Multiple arguments are separated by spaces so the argument name and value should
170-
use an `=` sign instead of a space.
171-
172-
!!! example
173-
174-
``` yaml
175-
extra-args: '-std=c++17 -Wall'
176-
```
177-
This will be passed to clang-tidy as multiple `--extra-arg` options:
178-
```
179-
clang-tidy --extra-arg=-std=c++17 --extra-arg=-Wall
180-
```
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.
181100
required: false
182101
default: ""
183-
minimum-version: '2.1.0'
184102
tidy-review:
185-
description: |
186-
Set this option to `true` to enable Pull Request reviews from clang-tidy.
187-
188-
!!! info "Important"
189-
This feature requires special permissions to perform successfully.
190-
See our [documented permissions](permissions.md).
191-
192-
See also [the PR review feature caveats](pr-review-caveats.md).
193-
194-
> [!NOTE]
195-
> The [`no-lgtm`](#no-lgtm) option is applicable to Pull Request reviews.
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
196104
required: false
197105
default: false
198-
experimental: true
199-
minimum-version: '2.9.0'
200-
required-permission: 'pull_request: write #pull-request-reviews'
201106
format-review:
202-
description: |
203-
Set this option to `true` to enable Pull Request reviews from clang-format.
204-
205-
!!! info "Important"
206-
This feature requires special permissions to perform successfully.
207-
See our [documented permissions](permissions.md).
208-
209-
See also [the PR review feature caveats](pr-review-caveats.md).
210-
211-
> [!NOTE]
212-
> The [`no-lgtm`](#no-lgtm) option is applicable to Pull Request reviews.
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
213108
required: false
214109
default: false
215-
minimum-version: '2.9.0'
216-
required-permission: 'pull_request: write #pull-request-reviews'
217110
outputs:
218111
checks-failed:
219112
description: An integer that can be used as a boolean value to indicate if any checks failed by clang-tidy and clang-format.
220113
value: ${{ steps.cpp-linter-unix.outputs.checks-failed || steps.cpp-linter-windows.outputs.checks-failed }}
221-
minimum-version: '1.2.0'
222114
clang-tidy-checks-failed:
223115
description: An integer that can be used as a boolean value to indicate if any checks failed by clang-tidy only.
224116
value: ${{ steps.cpp-linter-unix.outputs.clang-tidy-checks-failed || steps.cpp-linter-windows.outputs.clang-tidy-checks-failed }}
225-
minimum-version: '2.7.2'
226117
clang-format-checks-failed:
227118
description: An integer that can be used as a boolean value to indicate if any checks failed by clang-format only.
228119
value: ${{ steps.cpp-linter-unix.outputs.clang-format-checks-failed || steps.cpp-linter-windows.outputs.clang-format-checks-failed }}
229-
minimum-version: '2.7.2'
230120
runs:
231121
using: "composite"
232122
steps:

‎docs/badge_hook.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ def _badge_for_version(text: str, page: Page, files: Files):
5252
icon = "material-tag-outline"
5353
href = f"https://github.com/cpp-linter/cpp-linter-action/releases/v{text}"
5454
return _badge(
55-
icon=f'[:{icon}:]({href} "minimum version")',
56-
text=f'[{text}]({href} "minimum version")',
55+
icon=f'[:{icon}:]({href} "required version")',
56+
text=f'[{text}]({href} "required version")',
5757
)
5858

5959

‎docs/gen_io_doc.py

-69
This file was deleted.

0 commit comments

Comments
 (0)