A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/ below:

Inputs and Outputs - C/C++ Linter Action

Inputs and Outputs

These are the action inputs and outputs offered by cpp-linter-action.

Inputs style

1.2.0 Default'llvm'

The style rules to use.

extensions

1.2.0 Default'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx'

The file extensions to run the action against. This is a comma-separated string.

tidy-checks

1.2.0 Default'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'

Comma-separated list of globs with optional - prefix. Globs are processed in order of appearance in the list. Globs without - prefix add checks with matching names to the set, globs with the - prefix remove checks with matching names from the set of enabled checks. This option's value is appended to the value of the 'Checks' option in a .clang-tidy file (if any).

repo-root

1.2.0 Default'.'

The relative path to the repository root directory. This path is relative to the path designated as the runner's GITHUB_WORKSPACE environment variable.

version

1.2.0 Default16

The desired version of the clang-tools to use. Accepted options are strings which can be 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, or 8.

verbosity

1.3.0 Default'info'

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.

The verbosity can also be engaged by enabling debug logs when re-running jobs or workflows.

lines-changed-only

1.5.0 Defaultfalse contents: read

This controls what part of the files are analyzed. The following values are accepted:

files-changed-only

1.3.0 Defaulttrue contents: read

Set this option to false to analyze any source files in the repo. This is automatically enabled if lines-changed-only is enabled.

ignore

1.3.0 Default'.github'

Set this option with string of path(s) to ignore.

ignore-tidy

2.12.0 Default'.github'

Use this option to allow clang-tidy to ignore certain paths/files. See ignore for more details on possible values.

ignore-format

2.12.0 Default'.github'

Use this option to allow clang-format to ignore certain paths/files. See ignore for more details on possible values.

2.6.2 Default'false' contents: write

This controls the behavior of posted thread comments as feedback. The following options are supported:

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.

no-lgtm

2.6.2 Defaulttrue

Set this option to true or false to enable or disable the use of a thread comment or pull request review that basically says 'Looks Good To Me' (when all checks pass). The default value, true means no LGTM comment posted.

See thread-comments, tidy-review, and format-review options for further details.

step-summary

2.6.0 Defaultfalse

Set this option to true to append content as part of workflow's job summary.

See implementation details in GitHub's documentation about Adding a job summary. This option is independent of the thread-comments option, rather this option uses the same content that the thread-comments option would use.

Note

The no-lgtm option is not applied to step summaries.

file-annotations

1.4.3 Defaulttrue

Set this option to false to disable the use of file annotations as feedback.

database

1.4.0 Default''

The directory containing compilation database (like compile_commands.json) file.

2.1.0 Default''

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.

Example

extra-args: '-std=c++17 -Wall'

This will be passed to clang-tidy as multiple

--extra-arg

options:

clang-tidy --extra-arg=-std=c++17 --extra-arg=-Wall
tidy-review

2.9.0 Defaultfalse experimental pull-requests: write

Set this option to true to enable Pull Request reviews from clang-tidy.

Note

The no-lgtm option is applicable to Pull Request reviews.

format-review

2.9.0 Defaultfalse pull-requests: write

Set this option to true to enable Pull Request reviews from clang-format.

Note

The no-lgtm option is applicable to Pull Request reviews.

passive-reviews

2.12.0 Defaultfalse pull-requests: write

Set this option to true to prevent Pull Request reviews from approving or requesting changes.

jobs

2.11.0 Default0

The number of jobs to run in parallel. If less than or equal to 0, the number of jobs is set to use the number of all available CPU cores.

cache-enable

2.16.0 Defaulttrue

enable caching of cpp-linter dependencies

Outputs

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.

checks-failed

1.2.0

An integer that can be used as a boolean value to indicate if any checks failed by clang-tidy and clang-format.

clang-tidy-checks-failed

2.7.2

An integer that can be used as a boolean value to indicate if any checks failed by clang-tidy only.

clang-format-checks-failed

2.7.2

An integer that can be used as a boolean value to indicate if any checks failed by clang-format only.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4