Add clang-tidy to CI (#1830)

Author: tvami

.github/workflows/clang-tidy.yml

@@ -0,0 +1,49 @@
+name: Apply clang-tidy
+on:
+  pull_request:
+
+permissions:
+  contents: write
+
+jobs:
+  clang-tidy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install just
+      uses: extractions/setup-just@v3
+
+    - name: Checkout ldmx-sw
+      uses: actions/checkout@v5
+      with:
+        submodules: 'recursive'
+        fetch-depth: 0
+        ref: trunk
+ 
+    - name: Pull latest changes
+      run: |
+        git fetch origin ${GITHUB_HEAD_REF}
+        git checkout ${GITHUB_HEAD_REF}
+        git pull origin ${GITHUB_HEAD_REF}
+
+    - name: Run clang tidy on the C++
+      run: |
+        just install-denv init 
+        just compile
+        just tidy-cpp
+
+    - name: Set up git user as the bot
+      run: |
+        git config user.name 'github-actions[bot]'
+        git config user.email 'github-actions[bot]@users.noreply.github.com'
+
+    - name: Auto-commit the changes
+      run: |
+        git add .
+        git commit -m "Apply clang-tidy" || echo "No changes to commit"
+      id: commit
+
+    - name: Push changes
+      if: github.ref != 'refs/heads/trunk' 
+      run: |
+        git push origin HEAD:${GITHUB_HEAD_REF}
+

Ecal/test/EcalDigiPipelineTest.cxx

@@ -29,7 +29,7 @@ static const double MIP_SI_ENERGY = 0.130;
  * charge [fC] * (1000 electrons / 0.1602 fC) * (1 MIP / 37 000 electrons) *
  * (0.130 MeV / 1 MIP)
  */
-static const double ME_V_PER_F_C = MIP_SI_ENERGY / (37 * 0.1602);
+static const double MEV_PER_FC = MIP_SI_ENERGY / (37 * 0.1602);
 
 /**
  * Maximum percent error that a single hit
@@ -154,7 +154,7 @@ class EcalFakeSimHits : public framework::Producer {
    * The maximum value to be readout is 4096 TDC which
    * is equivalent to ~10000fC deposited charge.
    */
-  const double MAX_ENERGY = 10000. * ME_V_PER_F_C;
+  const double MAX_ENERGY = 10000. * MEV_PER_FC;
 
   /**
    * Minimum energy to make a sim hit for [MeV]
@@ -293,7 +293,7 @@ class EcalCheckEnergyReconstruction : public framework::Analyzer {
 
       auto trig_digi = trig_digis.at(0);
       float tp_energy =
-          8 * trig_digi.linearPrimitive() * 320. / 1024 * ME_V_PER_F_C;
+          8 * trig_digi.linearPrimitive() * 320. / 1024 * MEV_PER_FC;
 
       CHECK_THAT(tp_energy, IsCloseEnough(truth_energy, MAX_ENERGY_ERROR_TP,
                                           MAX_ENERGY_PERCENT_ERROR_TP));

justfile

@@ -180,8 +180,21 @@ tidy-cpp *ARGS='-p build --fix -fix-errors --quiet ':
     #!/usr/bin/env sh
     set -exu
     format_list=$(mktemp)
-    git diff --name-only --diff-filter=AM origin/trunk..HEAD | egrep '(\.h|\.cxx)$' | grep -v '^HLS' > ${format_list}
-    #git ls-tree -r HEAD --name-only | egrep '(\.h|\.cxx)$'   | grep -v '^HLS' > ${format_list}
+    git diff --name-only origin/trunk..HEAD | egrep '(\.h|\.cxx)$' > ${format_list}
+    # if the list is not empty, run clang-tidy
+    if [ ! -s ${format_list} ]; then
+      echo "No C++ files changed, skipping clang-tidy"
+    else
+      denv clang-tidy $(cat ${format_list}) {{ ARGS }}
+      rm ${format_list}
+    fi
+
+
+tidy-cpp-dir DIR *ARGS='-p build --fix -fix-errors --quiet ':
+    #!/usr/bin/env sh
+    set -exu
+    format_list=$(mktemp)
+    find {{ DIR }} -name "*.h" -o -name "*.cxx" > ${format_list}
     denv clang-tidy $(cat ${format_list}) {{ ARGS }}
     rm ${format_list}