Add Git hooks to format code automically#197
Open
lpottier wants to merge 4 commits into
Open
Conversation
Signed-off-by: Loic Pottier <pottier1@llnl.gov>
Signed-off-by: Loic Pottier <pottier1@llnl.gov>
Signed-off-by: Loic Pottier <pottier1@llnl.gov>
Signed-off-by: Loic Pottier <pottier1@llnl.gov>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 adds Git hooks for Clang format and Clang Tidy.
To add the hook, you can run:
git config core.hooksPath .githooksOtherwise, our CMake will add the hook automatically upon building.
the
.githook/pre-commitscript leverages a few environment variables:AMS_SKIP_TIDYif set, skip tidy, still run format. Example:AMS_SKIP_TIDY=1 git commitAMS_BUILD_DIRpoints to the build directory if you are not using something likebuild-*orbuild. Mandatory forclang-tidy.If you want to deactivate all hooks:
git commit --no-verify.If you want to run the hook without committing:
.githook/pre-commit