-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
986d3d4
commit 48388d4
Showing
9 changed files
with
281 additions
and
281 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,24 @@ | ||
| name: Linter | ||
|
|
||
| on: | ||
| pull_request | ||
|
|
||
| jobs: | ||
| check: | ||
| name: Run Linter | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v1 | ||
| - uses: ricardochaves/[email protected] | ||
| with: | ||
| python-root-list: "src test" | ||
| use-pylint: true | ||
| use-pycodestyle: true | ||
| use-flake8: true | ||
| use-black: true | ||
| use-mypy: true | ||
| use-isort: false | ||
| extra-pylint-options: "--rcfile=setup.cfg --max-line-length=120 --max-locals=25 --min-similarity-lines=10" | ||
| extra-mypy-options: "--ignore-missing-imports --show-error-codes" | ||
| extra-flake8-options: "--max-line-length=120 --ignore=E203,E402" | ||
| extra-pycodestyle-options: "--max-line-length=120 --ignore=E203,E402" | ||
| name: Linter | ||
|
|
||
| on: | ||
| pull_request | ||
|
|
||
| jobs: | ||
| check: | ||
| name: Run Linter | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v1 | ||
| - uses: ricardochaves/[email protected] | ||
| with: | ||
| python-root-list: "src test" | ||
| use-pylint: true | ||
| use-pycodestyle: true | ||
| use-flake8: true | ||
| use-black: true | ||
| use-mypy: true | ||
| use-isort: false | ||
| extra-pylint-options: "--rcfile=setup.cfg --max-line-length=120 --max-locals=25 --min-similarity-lines=10" | ||
| extra-mypy-options: "--ignore-missing-imports --show-error-codes" | ||
| extra-flake8-options: "--max-line-length=120 --ignore=E203,E402" | ||
| extra-pycodestyle-options: "--max-line-length=120 --ignore=E203,E402" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| .vscode/ | ||
| src/__pycache__/* | ||
| test/__pycache__/* | ||
| .vscode/ | ||
| src/__pycache__/* | ||
| test/__pycache__/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| FROM jdomagala/static_analysis:latest | ||
|
|
||
| COPY entrypoint.sh / | ||
| RUN chmod +x /entrypoint.sh | ||
|
|
||
| COPY src/run_static_analysis.py / | ||
| RUN chmod +x /run_static_analysis.py | ||
|
|
||
| COPY src/get_files_to_check.py / | ||
| RUN chmod +x /get_files_to_check.py | ||
|
|
||
| ENTRYPOINT ["/entrypoint.sh"] | ||
| FROM jdomagala/static_analysis:latest | ||
|
|
||
| COPY entrypoint.sh / | ||
| RUN chmod +x /entrypoint.sh | ||
|
|
||
| COPY src/run_static_analysis.py / | ||
| RUN chmod +x /run_static_analysis.py | ||
|
|
||
| COPY src/get_files_to_check.py / | ||
| RUN chmod +x /get_files_to_check.py | ||
|
|
||
| ENTRYPOINT ["/entrypoint.sh"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| The MIT License (MIT) | ||
| Copyright (c) 2021 GitHub, Inc. and contributors | ||
| 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. | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2021 GitHub, Inc. and contributors | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,101 +1,101 @@ | ||
| # Static Analysis | ||
|
|
||
| GitHub action for CMake based C++ project, that runs [cppcheck](http://cppcheck.sourceforge.net/) and [clang-tidy](https://clang.llvm.org/extra/clang-tidy/). This action works on both push and pull requests. | ||
|
|
||
| In order for this action to work properly, your project has to be CMake based and it's also recomennded to use ```.clang-tidy``` file, which should be located in your root directory. If your project requires some additional packages to be installed, you can use `apt_pckgs` and/or `init_script` input variables to install them (see the **Workflow example** or **Inputs** sections below). Also, if your repository should allow contribiutions from forks, then it's required to use this Action with `pull_request_target` trigger event, otherwise the GitHub API won't allow to create PR comments. | ||
|
|
||
| - **cppcheck** will run with the following default flags: </br> | ||
| ```--enable=all --suppress=missingInclude --inline-suppr --inconclusive``` | ||
| You can use `cppcheck_args` input to set your flags. | ||
|
|
||
| - **clang-tidy** will look for the ```.clang-tidy``` file in your repository, or you can set checks via `clang_tidy_args` input. | ||
|
|
||
| ## Pull Request comment | ||
|
|
||
| Created comment will contain code snippets with the issue description. When this action is run for the first time, the comment with the initial result will be created for current Pull Request. Consecutive runs will edit this comment with updated status. | ||
|
|
||
| Note that it's possible that the amount of issues detected can make the comment's body to be greater than the GitHub's character limit per PR comment (which is 65536). In that case, the created comment will contain only the isues found up to that point, and the information that the limit of characters was reached. | ||
|
|
||
| ### Output example | ||
|  | ||
|
|
||
| ## Non Pull Request | ||
|
|
||
| For non Pull Requests, the output will be printed to GitHub's output console. This behaviour can also be forced via `force_console_print` input. | ||
|
|
||
| ### Output example | ||
|  | ||
|
|
||
| ## Workflow example | ||
|
|
||
| ```yml | ||
| name: Static analysis | ||
|
|
||
| on: | ||
| # Will run on push when merging to 'branches'. The output will be shown in the console | ||
| push: | ||
| branches: | ||
| - develop | ||
| - master | ||
| - main | ||
|
|
||
| # 'pull_request_target' allows this Action to also run on forked repositories | ||
| # The output will be shown in PR comments (unless the 'force_console_print' flag is used) | ||
| pull_request_target: | ||
| branches: | ||
| - "*" | ||
|
|
||
| jobs: | ||
| static_analysis: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: setup init_script | ||
| shell: bash | ||
| run: | | ||
| echo "#!/bin/bash | ||
| add-apt-repository ppa:oibaf/graphics-drivers | ||
| apt update | ||
| apt upgrade | ||
| apt install -y libvulkan1 mesa-vulkan-drivers vulkan-utils" > init_script.sh | ||
| - name: Run static analysis | ||
| uses: JacobDomagala/StaticAnalysis@master | ||
| with: | ||
| # Exclude any issues found in ${Project_root_dir}/lib | ||
| exclude_dir: lib | ||
|
|
||
| # Additional apt packages that need to be installed before running Cmake | ||
| apt_pckgs: software-properties-common libglu1-mesa-dev freeglut3-dev mesa-common-dev | ||
|
|
||
| # Additional script that will be run (sourced) AFTER 'apt_pckgs' and before running Cmake | ||
| init_script: init_script.sh | ||
|
|
||
| # (Optional) clang-tidy args | ||
| clang_tidy_args: -checks='*,fuchsia-*,google-*,zircon-*,abseil-*,modernize-use-trailing-return-type' | ||
|
|
||
| # (Optional) cppcheck args | ||
| cppcheck_args: --enable=all --suppress=missingInclude | ||
| ``` | ||
| ## Inputs | ||
| | Name |Required| Description | Default value | | ||
| |-------------------------|--------|------------------------------------|:---------------:| | ||
| | `github_token` | FALSE | Github token used for Github API requests |`${{github.token}}`| | ||
| | `pr_num` | FALSE | Pull request number for which the comment will be created |`${{github.event.pull_request.number}}`| | ||
| | `comment_title` | FALSE | Title for comment with the raport. This should be an unique name | `Static analysis result` | | ||
| | `exclude_dir` | FALSE | Directory which should be excluded from the raport | `<empty>` | | ||
| | `apt_pckgs` | FALSE | Additional (space separated) packages that need to be installed in order for project to compile | `<empty>` | | ||
| | `init_script` | FALSE | Optional shell script that will be run before running CMake command. This should be used, when the project requires some environmental set-up beforehand. | `<empty>` | | ||
| | `cppcheck_args` | FALSE | Cppcheck (space separated) arguments that will be used |`--enable=all --suppress=missingInclude --inline-suppr --inconclusive`| | ||
| | `clang_tidy_args` | FALSE | clang-tidy arguments that will be used (example: `-checks='*,fuchsia-*,google-*,zircon-*'` |`<empty>`| | ||
| | `report_pr_changes_only`| FALSE | Only post the issues found within the changes introduced in this Pull Request. This means that only the issues found within the changed lines will po posted. Any other issues caused by these changes in the repository, won't be reported, so in general you should run static analysis on entire code base |`false`| | ||
| | `cmake_args` | FALSE | Additional CMake arguments |`<empty>`| | ||
| | `force_console_print` | FALSE | Output the action result to console, instead of creating the comment |`false`| | ||
|
|
||
|
|
||
|
|
||
| ### **NOTE: `apt_pckgs` will run before `init_script`, just in case you need some packages installed before running the script** | ||
| # Static Analysis | ||
|
|
||
| GitHub action for CMake based C++ project, that runs [cppcheck](http://cppcheck.sourceforge.net/) and [clang-tidy](https://clang.llvm.org/extra/clang-tidy/). This action works on both push and pull requests. | ||
|
|
||
| In order for this action to work properly, your project has to be CMake based and it's also recomennded to use ```.clang-tidy``` file, which should be located in your root directory. If your project requires some additional packages to be installed, you can use `apt_pckgs` and/or `init_script` input variables to install them (see the **Workflow example** or **Inputs** sections below). Also, if your repository should allow contribiutions from forks, then it's required to use this Action with `pull_request_target` trigger event, otherwise the GitHub API won't allow to create PR comments. | ||
|
|
||
| - **cppcheck** will run with the following default flags: </br> | ||
| ```--enable=all --suppress=missingInclude --inline-suppr --inconclusive``` | ||
| You can use `cppcheck_args` input to set your flags. | ||
|
|
||
| - **clang-tidy** will look for the ```.clang-tidy``` file in your repository, or you can set checks via `clang_tidy_args` input. | ||
|
|
||
| ## Pull Request comment | ||
|
|
||
| Created comment will contain code snippets with the issue description. When this action is run for the first time, the comment with the initial result will be created for current Pull Request. Consecutive runs will edit this comment with updated status. | ||
|
|
||
| Note that it's possible that the amount of issues detected can make the comment's body to be greater than the GitHub's character limit per PR comment (which is 65536). In that case, the created comment will contain only the isues found up to that point, and the information that the limit of characters was reached. | ||
|
|
||
| ### Output example | ||
|  | ||
|
|
||
| ## Non Pull Request | ||
|
|
||
| For non Pull Requests, the output will be printed to GitHub's output console. This behaviour can also be forced via `force_console_print` input. | ||
|
|
||
| ### Output example | ||
|  | ||
|
|
||
| ## Workflow example | ||
|
|
||
| ```yml | ||
| name: Static analysis | ||
|
|
||
| on: | ||
| # Will run on push when merging to 'branches'. The output will be shown in the console | ||
| push: | ||
| branches: | ||
| - develop | ||
| - master | ||
| - main | ||
|
|
||
| # 'pull_request_target' allows this Action to also run on forked repositories | ||
| # The output will be shown in PR comments (unless the 'force_console_print' flag is used) | ||
| pull_request_target: | ||
| branches: | ||
| - "*" | ||
|
|
||
| jobs: | ||
| static_analysis: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: setup init_script | ||
| shell: bash | ||
| run: | | ||
| echo "#!/bin/bash | ||
| add-apt-repository ppa:oibaf/graphics-drivers | ||
| apt update | ||
| apt upgrade | ||
| apt install -y libvulkan1 mesa-vulkan-drivers vulkan-utils" > init_script.sh | ||
| - name: Run static analysis | ||
| uses: JacobDomagala/StaticAnalysis@master | ||
| with: | ||
| # Exclude any issues found in ${Project_root_dir}/lib | ||
| exclude_dir: lib | ||
|
|
||
| # Additional apt packages that need to be installed before running Cmake | ||
| apt_pckgs: software-properties-common libglu1-mesa-dev freeglut3-dev mesa-common-dev | ||
|
|
||
| # Additional script that will be run (sourced) AFTER 'apt_pckgs' and before running Cmake | ||
| init_script: init_script.sh | ||
|
|
||
| # (Optional) clang-tidy args | ||
| clang_tidy_args: -checks='*,fuchsia-*,google-*,zircon-*,abseil-*,modernize-use-trailing-return-type' | ||
|
|
||
| # (Optional) cppcheck args | ||
| cppcheck_args: --enable=all --suppress=missingInclude | ||
| ``` | ||
| ## Inputs | ||
| | Name |Required| Description | Default value | | ||
| |-------------------------|--------|------------------------------------|:---------------:| | ||
| | `github_token` | FALSE | Github token used for Github API requests |`${{github.token}}`| | ||
| | `pr_num` | FALSE | Pull request number for which the comment will be created |`${{github.event.pull_request.number}}`| | ||
| | `comment_title` | FALSE | Title for comment with the raport. This should be an unique name | `Static analysis result` | | ||
| | `exclude_dir` | FALSE | Directory which should be excluded from the raport | `<empty>` | | ||
| | `apt_pckgs` | FALSE | Additional (space separated) packages that need to be installed in order for project to compile | `<empty>` | | ||
| | `init_script` | FALSE | Optional shell script that will be run before running CMake command. This should be used, when the project requires some environmental set-up beforehand. | `<empty>` | | ||
| | `cppcheck_args` | FALSE | Cppcheck (space separated) arguments that will be used |`--enable=all --suppress=missingInclude --inline-suppr --inconclusive`| | ||
| | `clang_tidy_args` | FALSE | clang-tidy arguments that will be used (example: `-checks='*,fuchsia-*,google-*,zircon-*'` |`<empty>`| | ||
| | `report_pr_changes_only`| FALSE | Only post the issues found within the changes introduced in this Pull Request. This means that only the issues found within the changed lines will po posted. Any other issues caused by these changes in the repository, won't be reported, so in general you should run static analysis on entire code base |`false`| | ||
| | `cmake_args` | FALSE | Additional CMake arguments |`<empty>`| | ||
| | `force_console_print` | FALSE | Output the action result to console, instead of creating the comment |`false`| | ||
|
|
||
|
|
||
|
|
||
| ### **NOTE: `apt_pckgs` will run before `init_script`, just in case you need some packages installed before running the script** |
Oops, something went wrong.