clang-tidy pull request comments
A GitHub Action to post clang-tidy warnings and suggestions as review comments on your pull request.
What
platisd/clang-tidy-pr-comments is a GitHub Action that utilizes the exported fixes of clang-tidy for your C++ project and posts them as code review comments in the related pull request.
If clang-tidy has a concrete recommendation on how you should modify your code to fix the issue that's detected, then it will be presented as a suggested change that can be committed directly. Alternatively, the offending line will be highlighted along with a description of the warning.
The GitHub Action can be configured to request changes if clang-tidy warnings are found or merely leave a comment without blocking the pull request from being merged. It should fail only if it has been misconfigured by you, due to a bug (please contact me if that's the case) or the GitHub API acting up.
Please note the following:
- It will not run
clang-tidyfor you. You are responsible for doing that and then supply the Action with the path to your generated report (see examples below).
Specifically, the YAML report that includes the fixes is generated via the-export-fixesargument to therun-clang-tidyutility script. Alternatively, you may use--export-fixeswithclang-tidyitself and then, in both cases, specify the path where you would like the report to be exported.
The very same path should be supplied to the GitHub Action. - It will only comment on files and lines changed in the pull request. This is due to GitHub not allowing comments on other files outside the pull request
diff. This means that there may be more warnings in your project. Make sure you fix them before starting to use this Action to ensure new warnings will not be introduced in the future. - Having the Action leave comments on every update of the pull request may result in spam. Specifically, existing comments are not taken into consideration and will be repeated every time the Action is triggered, as long as the violation has not been amended. If you see this becoming an issue, consider triggering it manually with a comment instead (see example below).
Supported clang-tidy versions
YAML files containing generated fixes by the following clang-tidy versions are currently supported:
clang-tidy-8clang-tidy-9clang-tidy-10clang-tidy-11clang-tidy-12
How
Since this action comments on files changed in pull requests, naturally, it can be only run on pull_request events. That being said, if it happens to be triggered in a different context, e.g. a push event, it will not run and fail softly by returning a success code.
A basic configuration for the platisd/clang-tidy-pr-comments action can be seen below:
name: Static analysis
on: pull_request
jobs:
clang-tidy:
runs-on: ubuntu-20.04
steps:
- uses: actions/[email protected]
- name: Build project and/or unit tests
run: ./your-build-script.sh
- name: Run clang-tidy
run: ./your-clang-tidy-script.sh --fixes-path fixes.yaml
- name: Run clang-tidy-pr-comments action
uses: platisd/[email protected]
with:
# The GitHub token (or a personal access token)
github_token: ${{ secrets.GITHUB_TOKEN }}
# The path to the clang-tidy fixes generated previously
clang_tidy_fixes: fixes.yaml
# Optionally set to true if you want the Action to request
# changes in case warnings are found
request_changes: true
# Optionally set the number of comments per review
# to avoid GitHub API timeouts for heavily loaded
# pull requests
suggestions_per_comment: 10
If you want to trigger the Action manually, i.e. by leaving a comment with a particular keyword in the pull request, then you can try the following:
name: Static analysis
# Don't trigger it on pull_request events but issue_comment instead
on: issue_comment
jobs:
clang-tidy:
# Trigger the job only when someone comments: run_clang_tidy
if: github.event.issue.pull_request && contains(github.event.comment.body, 'run_clang_tidy')
runs-on: ubuntu-20.04
steps:
- uses: actions/[email protected]
- name: Build project and/or unit tests
run: ./your-build-script.sh
- name: Run clang-tidy
run: ./your-clang-tidy-script.sh --fixes-path fixes.yaml
- name: Run clang-tidy-pr-comments action
uses: platisd/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
clang_tidy_fixes: fixes.yaml
The suggestion in the image would result in an ill-formed json
24 Dec 10, 2022
201 Dec 12, 2022
237 Dec 10, 2022
0 Nov 12, 2022
3.3k Dec 28, 2022
11 Feb 18, 2022
43 Dec 23, 2022
21 Nov 24, 2022
3.1k Dec 29, 2022
762 Dec 29, 2022
8 Dec 10, 2022
63 Dec 25, 2022
96 Dec 21, 2022
1 Mar 14, 2022
8 Dec 25, 2022
5 Dec 08, 2021
4 Jan 01, 2023
1 Mar 16, 2022
230 Nov 16, 2022
126 Jan 02, 2023