jacobdomagala/Static analysis for C++/Python project
Static analysis with cppcheck & clang-tidy for C++, pylint for Python. Posts results to PRs or console.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | Github token used for Github API requests | — | ${{ github.token }} |
| pr_num | Pull request number for which the comment will be created | — | ${{ github.event.pull_request.number }} |
| repo | Repository name | — | ${{ github.repository }} |
| pr_repo | Head repository (This is useful when using Action with [pull_request_target]) | — | ${{ github.event.pull_request.head.repo.full_name }} |
| pr_head | Head (branch) for PR (same as `pr_repo` input, useful with [pull_request_target] | — | ${{ github.event.pull_request.head.ref }} |
| comment_title | Title for comment with the raport. This should be an unique name | — | Static analysis result |
| exclude_dir | Directories (space separated) which should be excluded from the raport | — | — |
| apt_pckgs | Additional (space separated) packages that need to be installed in order for project to compile | — | — |
| compile_commands | User generated compile_commands.json | — | — |
| compile_commands_replace_prefix | Whether we should replace the prefix of files inside user generated compile_commands.json file | — | false |
| init_script | 'Optional shell script that will be run before configuring project (i.e. running CMake command).' 'This should be used, when the project requires some environmental set-up beforehand' 'Script will be run with 2 arguments: `root_dir`(root directory of user's code) and `build_dir`(build directory created for running SA)' 'Note. `apt_pckgs` will run before this script, just in case you need some packages installed' 'Also this script will be run in the root of the project (`root_dir`)' | — | — |
| cppcheck_args | cppcheck (space separated) arguments that will be used | — | --enable=all --suppress=missingIncludeSystem --inline-suppr --inconclusive |
| clang_tidy_args | clang-tidy arguments that will be used (example: -checks="*,fuchsia-*,google-*,zircon-*" | — | — |
| report_pr_changes_only | Only post the issues found within the changes introduced in this Pull Request | — | false |
| use_cmake | Determines wether CMake should be used to generate compile_commands.json file | — | true |
| cmake_args | Additional CMake arguments | — | — |
| force_console_print | Output the action result to console, instead of creating the comment | — | false |
| verbose | Verbose output. Used for debugging | — | false |
| language | Programming language to check for. Supported languages are: C++/Python | — | C++ |
| pylint_args | PyLint options | — | — |
| python_dirs | Directories containing python files to be checked | — | — |
Outputs
no outputs