Better CI Format Check #466
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
tprk77
approved these changes
Aug 7, 2023
format_code.sh
Outdated
| | xargs clang-format -i | ||
| | xargs clang-format-12 -i |
There was a problem hiding this comment.
As a small refactor, it might be good to use a constant for this. For example, put CLANG_FORMAT="clang-format-12" somewhere at the top and do | xargs $CLANG_FORMAT -i here.
There was a problem hiding this comment.
Sounds good to me! 0efd380
ihilt
approved these changes
Aug 7, 2023
refactor to use env var
nosracd
force-pushed
the
ci/better_format
branch
from
6932d24
to
e0f3a51
Compare
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.
Different versions of
clang-formatformat differently. The CI usesclang-format-12for consistency, butformat_code.shdoes not specify a version. This can result in situations whereformat_code.shreports well-formatted code locally but not on the CI, such as in this case.b1c8fec remedies this by forcing
format_code.shto useclang-format-12and instructing the user to install that particular version if it's not available.Unfortunately, this means that some people are much older or newer distributions might not be able to use the formatter locally. While docker is always an option, 6932d24 attempts to ease this pain by printing the desired format on the CI (example CI success, example CI failure).