Add Clang-Tidy GitHub Action Linter #171
Conversation
dchansen06
added
Enhancement
dchansen06
added
3 NORMAL
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
Updated your branch with a rebase to keep it updated in prep for #165 |
dchansen06
changed the title
.github/workflows/Linter.yml
Outdated
| - name: Install dependencies | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y clang-tidy cmake ninja-build |
There was a problem hiding this comment.
These 3 pieces of software are installed by default on the ubuntu-latest runner you do not need to install them again see the docs for a list of other installed packages.
There was a problem hiding this comment.
I imagine as part of this you will find actual bugs in our codebase, when you do please document them to the best of your ability in a new GitHub issue for each, thanks!
|
Updating with rebase again |
|
Updated with rebase |
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
|
I noticed your PR runs only on changed files (which breaks due to how header files can include things) so I ran it over all of them and got... not good results What options are there? Is there a way to hide less important errors? I already filtered out |
dchansen06
left a comment
dchansen06
left a comment
There was a problem hiding this comment.
May need to update the .clang-tidy or something else, I am not sure, but there are a lot of errors and warnings from the linter which is not good
To see them on the GitHub Action run
git ls-files '*.c' '*.h' | grep -v "Lib/Vendor" | xargs clang-tidy -p build/Debug
.github/workflows/Linter.yml
Outdated
|
|
||
| - name: Run clang-tidy | ||
| run: | | ||
| files=$(git diff --name-only origin/${{ github.base_ref }} | grep -E '\.(cpp|cc|cxx|c)$' || true) |
There was a problem hiding this comment.
For getting changed files please use an action like changed-files it is a bit cleaner
Can you for now please make it
- Auto fix what it can (and save changes)
- Fail the job on failure
There was a problem hiding this comment.
Just to clarify sorry, if you are going to do it with git diff please use the provided action, but in most cases we want to run on all files if you could please make that the default, thanks!
| release: '12.2.Rel1' | ||
|
|
||
| - name: Configure | ||
| run: cmake --preset Debug |
There was a problem hiding this comment.
Is there a way to avoid linting on just one preset?
Co-authored-by: Daniel Hansen <105574022+dchansen06@users.noreply.github.com> Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Co-authored-by: Daniel Hansen <105574022+dchansen06@users.noreply.github.com> Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Simplify clang-tidy execution by removing file check. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Removed some checks and warnings, updated header filter regex. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Added steps to get changed C/C++ files and auto-fix issues using clang-tidy. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
2 participants
Clang-Tidy Linter
Problem and Scope
Meant to solve issue #163. Clang-tidy system is set up.
Description
Default clang-tidy file is added. Should cover most limitations of CodeQL. Github action is added (pretty simple, runs on pull request).
Gotchas and Limitations
I have no idea how it interacts with the other .yml files.
Testing
Using bugprone for warnings as errors outputs too many errors. It is currently set as clang-analyzer. If the output spam occurs please revert back to nothing for warnings as errors.
Testing Details
Larger Impact
Additional Context and Ticket