Add clang tidy #5
Merged
Conversation
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
henrygerardmoore
commented
Oct 4, 2024
Jenkinsfile
Outdated
There was a problem hiding this comment.
We're not using this.
henrygerardmoore
commented
Oct 4, 2024
.github/workflows/ros2.yml
Outdated
There was a problem hiding this comment.
Our CI replaces industrial CI
henrygerardmoore
commented
Oct 4, 2024
Dockerfile
Outdated
| @@ -20,6 +20,7 @@ WORKDIR /colcon_ws | |||
| # hadolint ignore=SC1091 | |||
| RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \ | |||
| --mount=type=cache,target=/var/lib/apt,sharing=locked \ | |||
| --mount=type=cache,target=/$HOME/.cache,sharing=locked \ | |||
There was a problem hiding this comment.
I think pip in the docker container needs this in CI, was getting errors without it.
henrygerardmoore
commented
Oct 4, 2024
There was a problem hiding this comment.
All changes in this file are just from clang tidy, wanted to have one changed CPP file to make sure it works.
henrygerardmoore
commented
Oct 4, 2024
run_clang_tidy.bash
Outdated
There was a problem hiding this comment.
Just a convenience script I've used before for developers to run clang tidy locally if they should want.
henrygerardmoore
commented
Oct 4, 2024
| HeaderFilterRegex: '' | ||
| AnalyzeTemporaryDtors: false |
There was a problem hiding this comment.
No longer a valid option in clang tidy 18
bgill92
approved these changes
Oct 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds clang tidy to our CI, but not to pre-commit, though it does add a convenience script for running clang-tidy locally. It'll only run on changed files, but it's still pretty slow.
I changed that one cpp file just to make sure that clang-tidy is working properly. Ideally we could apply all clang tidy changes across the code base at once, but that was a big burden that I didn't want to take on, so I think making it required for any files a PR touches is a good middle ground that will ensure the code quality goes up over time.
The
.clang-tidyis one I've used in personal and work projects before and has a configuration I like. I think that's sufficient for this repo.