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>
Added steps to install dependencies and configure the build. 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>
Replaced clang-tidy-review actions with a direct clang-tidy command. 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>
Removed installation of clang-tidy and cmake from dependencies. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Removed the 'Configure' step from the Linter workflow. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Removed AnalyzeTemporaryDtors option from clang-tidy configuration. Signed-off-by: ReginaldWang <114448545+ReginaldWang@users.noreply.github.com>
Added a configuration step and improved clang-tidy invocation. 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 seems reasonable) 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| contents: read | ||
|
|
||
| jobs: | ||
| build: |
There was a problem hiding this comment.
| build: | |
| tidy: |
There was a problem hiding this comment.
Also please add a name like the other ones name: Clang-Tidy
|
|
||
| - 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
| echo "No C/C++ source files changed" | ||
| exit 0 | ||
| fi | ||
| clang-tidy -p build $files |
There was a problem hiding this comment.
| clang-tidy -p build $files | |
| clang-tidy -p build/Debug $files |
| 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?
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
Testing Details
Larger Impact
Additional Context and Ticket