This is v3 of my series to add clang-format to the CI. The series was mostly inspired by a patch sent recently to 'include kh_foreach* macros in ForEachMacros' [1]. I was wondering why we don't run the formatting on CI and reduce some of the workload of reviewers. We have a '.clang-format' file to provide rules for code formatting. The commits 1-5 aims to add more rules to the file while deprecating old ones. Commit 6 enables CI action on GitHub and GitLab to also check for the code formatting. Currently, it is allowed to fail. This way we can build confidence and fine tune the values as needed and finally enforce the check in a future patch. I'm not well versed with GitHub workflows, and I mostly tried to copy existing work there. Expecting some feedback in that section! Commit 7 fixes an existing issue with the 'check-whitespace' job, which is failing as success in the GitLab CI. Commit 8 adds the `RemoveBracesLLVM` only in the context of the CI. If we decide against it, we could drop this commit from the series. 1: https://lore.kernel.org/git/4e7893f5-2dd9-46cf-8a64-cf780f4e1730@xxxxxx/ Changes against v3: - The job was actually failing on GitHub but showing a success since we added the allow to fail clause. This was because the dependency wasn't installed. Have fixed that in this version. - Simplified the bash script in the GitLab job, thanks to Junio. - Fixed a style issue with redirection. - Added some more details to the commit messages. Job running on: - GitHub: https://github.com/KarthikNayak/git/actions/runs/9936188558/job/27443871938?pr=1 - GitLab: https://gitlab.com/gitlab-org/git/-/jobs/7340770469 Karthik Nayak (8): clang-format: indent preprocessor directives after hash clang-format: avoid spacing around bitfield colon clang-format: ensure files end with newlines clang-format: replace deprecated option with 'SpacesInParens' clang-format: formalize some of the spacing rules ci: run style check on GitHub and GitLab check-whitespace: detect if no base_commit is provided ci/style-check: add `RemoveBracesLLVM` to '.clang-format' .clang-format | 36 +++++++++++++++++++++++++----- .github/workflows/check-style.yml | 34 ++++++++++++++++++++++++++++ .gitlab-ci.yml | 37 ++++++++++++++++++++++++++++++- ci/check-whitespace.sh | 10 +++++++-- ci/install-dependencies.sh | 6 ++++- ci/run-style-check.sh | 21 ++++++++++++++++++ 6 files changed, 135 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/check-style.yml create mode 100755 ci/run-style-check.sh Range-diff against v3: 1: 6cf91ffc86 = 1: 6cf91ffc86 clang-format: indent preprocessor directives after hash 2: beb002885f = 2: beb002885f clang-format: avoid spacing around bitfield colon 3: 3031be43e7 = 3: 3031be43e7 clang-format: ensure files end with newlines 4: bc1550e300 = 4: bc1550e300 clang-format: replace deprecated option with 'SpacesInParens' 5: 4586c0094b = 5: 4586c0094b clang-format: formalize some of the spacing rules 6: c18cb23369 ! 6: f8eba92c0c ci: run style check on GitHub and GitLab @@ Commit message this job to fail, so we can validate if this is useful and eventually enforce it. - For GitLab, we use the 'CI_MERGE_REQUEST_TARGET_BRANCH_SHA' variable by - default to obtain the base SHA of the merged pipeline (which is only - available for merged pipelines [1]). Otherwise we use the + For GitHub, we allow the job to pass by adding 'continue-on-error: true' + to the workflow. This means the job would show as passed, even if the + style check failed. To know the status of the job, users have to + manually check the logs. + + For GitLab, we allow the job to pass by adding 'allow_failure: true', to + the job. Unlike GitHub, here the job will show as failed with a yellow + warning symbol, but the pipeline would still show as passed. + + Also for GitLab, we use the 'CI_MERGE_REQUEST_TARGET_BRANCH_SHA' + variable by default to obtain the base SHA of the merged pipeline (which + is only available for merged pipelines [1]). Otherwise we use the 'CI_MERGE_REQUEST_DIFF_BASE_SHA' variable. [1]: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html#predefined-variables-for-merge-request-pipelines + Helped-by: Junio C Hamano <gitster@xxxxxxxxx> Signed-off-by: Karthik Nayak <karthik.188@xxxxxxxxx> ## .github/workflows/check-style.yml (new) ## @@ .github/workflows/check-style.yml (new) + +jobs: + check-style: ++ env: ++ CC: clang ++ jobname: ClangFormat + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + ++ - run: ci/install-dependencies.sh ++ + - name: git clang-format + continue-on-error: true + id: check_out @@ .gitlab-ci.yml: check-whitespace: + allow_failure: true + variables: + CC: clang ++ jobname: ClangFormat + before_script: + - ./ci/install-dependencies.sh + # Since $CI_MERGE_REQUEST_TARGET_BRANCH_SHA is only defined for merged @@ .gitlab-ci.yml: check-whitespace: + # be defined in all pipelines. + script: + - | -+ if test -n "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA" -+ then -+ ./ci/run-style-check.sh "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA" -+ elif test -n "$CI_MERGE_REQUEST_DIFF_BASE_SHA" ++ R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA-${CI_MERGE_REQUEST_DIFF_BASE_SHA?}} ++ ++ if test -z "$R" + then -+ ./ci/run-style-check.sh "$CI_MERGE_REQUEST_DIFF_BASE_SHA" -+ else -+ echo "CI_MERGE_REQUEST_DIFF_BASE_SHA should always exist!"; exit 1 ++ echo "CI_MERGE_REQUEST_DIFF_BASE_SHA should always exist!" ++ exit 1 + fi ++ ./ci/run-style-check.sh "$R" + rules: + - if: $CI_PIPELINE_SOURCE == 'merge_request_event' + @@ ci/install-dependencies.sh: ubuntu-*) mkdir --parents "$CUSTOM_PATH" wget --quiet --directory-prefix="$CUSTOM_PATH" \ +@@ ci/install-dependencies.sh: macos-*) + esac + + case "$jobname" in ++ClangFormat) ++ sudo apt-get -q update ++ sudo apt-get -q -y install clang-format ++ ;; + StaticAnalysis) + sudo apt-get -q update + sudo apt-get -q -y install coccinelle libcurl4-openssl-dev libssl-dev \ ## ci/run-style-check.sh (new) ## @@ 7: 4d08c570bb ! 7: 477419fc6b check-whitespace: detect if no base_commit is provided @@ Commit message [1]: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html#predefined-variables-for-merge-request-pipelines + Helped-by: Junio C Hamano <gitster@xxxxxxxxx> Signed-off-by: Karthik Nayak <karthik.188@xxxxxxxxx> ## .gitlab-ci.yml ## @@ .gitlab-ci.yml: check-whitespace: script: - - ./ci/check-whitespace.sh "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA" + - | -+ if test -n "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA" -+ then -+ ./ci/check-whitespace.sh "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA" -+ elif test -n "$CI_MERGE_REQUEST_DIFF_BASE_SHA" ++ R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA-${CI_MERGE_REQUEST_DIFF_BASE_SHA?}} ++ ++ if test -z "$R" + then -+ ./ci/check-whitespace.sh "$CI_MERGE_REQUEST_DIFF_BASE_SHA" -+ else -+ echo "CI_MERGE_REQUEST_DIFF_BASE_SHA should always exist!"; exit 1 ++ echo "CI_MERGE_REQUEST_DIFF_BASE_SHA should always exist!" ++ exit 1 + fi ++ ./ci/check-whitespace.sh "$R" rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' 8: 2b39431f93 ! 8: 50007c17da ci/style-check: add `RemoveBracesLLVM` to '.clang-format' @@ Commit message its efficacy and decide if we want to add it to '.clang-format' or retract it entirely. + A more ideal solution would be if 'clang-format' allowed us to append + rules to the existing '.clang-format' when invoked. But such an option + does not exist. Since modifying the in-tree '.clang-format' is only done + on the CI job for style-check and doesn't affect any other jobs and is + not persisted in any ways, this hack should be okay. + [1]: https://clang.llvm.org/docs/ClangFormatStyleOptions.html#removebracesllvm Signed-off-by: Karthik Nayak <karthik.188@xxxxxxxxx> @@ ci/run-style-check.sh +# While also ensuring that end-users are not affected directly. +# +# [1]: https://clang.llvm.org/docs/ClangFormatStyleOptions.html#removebracesllvm -+echo "RemoveBracesLLVM: true" >> .clang-format ++echo "RemoveBracesLLVM: true" >>.clang-format + git clang-format --style file --diff --extensions c,h "$baseCommit" -- 2.45.2
