Enable linting of CMake files using pre-commit #9484
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
…gs gracefully for both cmake-format and cmake-lint.
… the config is not present, and exits with failure if the linters run and fail.
vyasr
added
feature request
github-actions
bot
added
libcudf
Codecov Report
@@ Coverage Diff @@
## branch-21.12 #9484 +/- ##
================================================
- Coverage 10.79% 10.66% -0.13%
================================================
Files 116 117 +1
Lines 18869 19726 +857
================================================
+ Hits 2036 2104 +68
- Misses 16833 17622 +789
Continue to review full report at Codecov.
|
harrism
approved these changes
Oct 26, 2021
|
@robertmaynard I think this should be good to go now. |
robertmaynard
approved these changes
Oct 29, 2021
|
rerun tests |
|
@gpucibot merge |
This was referenced Nov 2, 2021
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 PR resolves #9396, making it easy to run
cmake-formatandcmake-linton CMake files in cudf using pre-commit. The one additional complexity associated with these hooks compared to our other pre-commit hooks is the need for thecmake-format-rapids-cmake.jsonconfiguration file that is maintained in rapids-cmake and is only added during the build process. We don't want pre-commit to fail outright when the file isn't present, so this PR introduces a custom script wrapping thecmake-formatandcmake-linthooks in a check for the presence of the file. The script respects an associated environment variable that advanced users can exploit if they store this file in a nonstandard location.Once this PR is finalized I'll make a follow-up PR that actually applies the formatting to our existing CMake.