Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deep5050/cppcheck-action
A github action to perform C/C++ security checks automatically
https://github.com/deep5050/cppcheck-action
analysis c code-quality code-review cpp cppcheck-action cppcheck-documentations dangerous-coding-constructs performance-analysis security-testing static-analysis vulnerability-detection
Last synced: about 1 month ago
JSON representation
A github action to perform C/C++ security checks automatically
- Host: GitHub
- URL: https://github.com/deep5050/cppcheck-action
- Owner: deep5050
- License: mit
- Created: 2020-04-24T16:58:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T05:58:20.000Z (over 1 year ago)
- Last Synced: 2024-07-25T02:43:48.732Z (about 2 months ago)
- Topics: analysis, c, code-quality, code-review, cpp, cppcheck-action, cppcheck-documentations, dangerous-coding-constructs, performance-analysis, security-testing, static-analysis, vulnerability-detection
- Language: C
- Homepage:
- Size: 142 KB
- Stars: 38
- Watchers: 2
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## [subscribe to service updates](https://github.com/deep5050/cppcheck-action/issues/11)
> ** Please participate on this
> [poll](https://github.com/deep5050/cppcheck-action/issues/10) for a feature
> planned by me **
## What is cppcheck?
[cppcheck](https://github.com/danmar/cppcheck) is a static analysis tool for
C/C++ code. It provides unique code analysis to detect bugs and focuses on
detecting undefined behavior and dangerous coding constructs. The goal is to
have very few false positives. Cppcheck is designed to be able to analyze your
C/C++ code even if it has non-standard syntax (common in embedded projects).
## How to use?
Create `cppcheck.yml` under `.github/workflows` With the following contents
### Default configuration
```yml
name: cppcheck-action-test
on: [push]
jobs:
build:
name: cppcheck-test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: cppcheck
uses: deep5050/cppcheck-action@main
with:
github_token: ${{ secrets.GITHUB_TOKEN}}
- name: publish report
uses: mikeal/publish-to-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH_NAME: 'main' # your branch name goes here
```
### Advanced configuration
```yml
name: cppcheck-action
on: [push]
jobs:
build:
name: cppcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: cppcheck
uses: deep5050/cppcheck-action@main
with:
github_token: ${{ secrets.GITHUB_TOKEN}}
check_library:
skip_preprocessor:
enable:
exclude_check:
inconclusive:
inline_suppression:
force_language:
force:
max_ctu_depth:
platform:
std:
output_file:
other_options:
- name: publish report
uses: mikeal/publish-to-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH_NAME: 'main' # your branch name goes here
```
### Input options
| Option | Value | Description | Default |
| :--- | :--- | :--- | :--- |
| **check_library** | `enable`, `disable` | Show information messages when library files have incomplete info | `disable` |
| **skip_preprocessor** | `enable`, `disable` | Print preprocessor output on stdout and don't do any further processing | `disable` |
| **enable** | `all`, `warning`, `style`, `performance`, `portability`, `information`, `unusedFunction`, `missingInclude` | Enable additional checks. if you want to enable multiple checking at once, separate them using `,` without any blank space. example: `style,warning,performance` | `all` |
| **exclude_check** | `./path/to/ignore` | Give a file or directory path to exclude from checking. example: `./no_check.cpp` | nothing to ignore |
| **inconclusive** | `enable`, `disable` | Allow that Cppcheck reports even though the analysis is inconclusive | `enable` |
| **inline_suppression** | `enable`, `disable` | Enable inline suppressions. Use them by placing one or more comments, like: '// cppcheck-suppress warningId' | `disable` |
| **force_language** | `c`, `c++` | Forces cppcheck to check all files as the given language. Valid values are: `c`, `c++` | auto-detected |
| **force** | `enable`, `disable` | Force checking of all configurations in files | `disable` |
| **max_ctu_depth** | `number` | Max depth in whole program analysis. A larger value will mean more errors can be found but also means the analysis will be slower. example: `4` | `2` |
| **platform** | `unix32`, `unix64`, `win32A`, `win32W`, `win64`, `avr8`, `elbrus-e1cp`, `pic8`, `pic8-enhanced`, `pic16`, `mips32`, `native`, `unspecified`, | Specifies platform specific types and sizes | `unspecified` |
| **std** | `c89`, `c99`, `c11`, `c++11`, `c++14`, `c++17`, `c++20` | Set the C/C++ standard | `c11`, `c++20` |
| **output_file** | `./path/to/output/file.txt` | Give a filename for the output report | `./cppcheck_report.txt` |
| **other_options** | `--option1 --option2=value -opt3` | Any other options you want to add, separate with a space, wrong options will cause a failure. example: `--bug-hunting --verbose`| `disable` |
For further details check
[cppcheck documentations](http://cppcheck.sourceforge.net/manual.pdf)
## License
> MIT License
> Copyright (c) 2021 Dipankar Pal
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Thanks
Icons made by
Freepik
from www.flaticon.com
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
### Related
[](https://github.com/deep5050/count-comments-action)
[](https://github.com/deep5050/MastJokeMara)
[](https://github.com/deep5050/memes-on-issues-action)
[](https://github.com/deep5050/smart-radio)
