Merge pull request InsightSoftwareConsortium#5239 from thewtex/pre-commit-gh-action

ENH: Add pre-commit GitHub Action

Author: thewtex

.clang-format

@@ -1,4 +1,4 @@
-## This config file is only relevant for clang-format version 19.1.4
+## This config file is only relevant for clang-format version 19.1.7
 ##
 ## Examples of each format style can be found on the in the clang-format documentation
 ## See: https://clang.llvm.org/docs/ClangFormatStyleOptions.html for details of each option
@@ -10,11 +10,11 @@
 ## maintaining a consistent code style.
 ##
 ## EXAMPLE apply code style enforcement before commit:
-#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.4} --modified
+#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.7} --modified
 ## EXAMPLE apply code style enforcement after commit:
-#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.4} --last
+#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.7} --last
 ---
-# This configuration requires clang-format version 19.1.4 exactly.
+# This configuration requires clang-format version 19.1.7 exactly.
 Language:        Cpp
 AccessModifierOffset: -2
 AlignAfterOpenBracket: Align

.github/workflows/pre-commit.yml

@@ -0,0 +1,22 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@v4
+    - name: Check install of Python, pre-commit
+      run: |
+        ./Utilities/GitSetup/setup-precommit
+        git config hooks.SetupForDevelopment 99
+        git config user.email "you@example.com"
+        git config user.name "Your Name"
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -57,7 +57,7 @@ repos:
    - id: trailing-whitespace
      exclude: "\\.(sha|sha512|svg|vtk|vtp)$|\\/ThirdParty\\/|\\/Data\\/"
 - repo: https://github.com/pre-commit/mirrors-clang-format
-  rev: v19.1.4
+  rev: v19.1.7
   hooks:
   - id: clang-format
     args: ['--style=file']

Documentation/docs/releases/5.4.0.md

@@ -136,7 +136,7 @@ Unpack optional testing data in the same directory where the Library Source is u
 - Add `itk::Copy(const T & original)`, which simply returns a copy
 - Make `itk::ImageRegion` trivially copyable, remove inheritance (FUTURE)
 - `itk::VTKPolyDataMeshIO` support for reading VTK 5.1 format
-- Add `ITK_DEFAULT_COPY_AND_MOVE(TypeName)` macro definition 
+- Add `ITK_DEFAULT_COPY_AND_MOVE(TypeName)` macro definition
 - Replace `(const std::string)` casts with C++17 `std::string_view`
 - Replace SetSize/Index calls in tests with `region{ index, size }`
 - Optionally limit an `ImageMask` to a specific pixel value
@@ -229,7 +229,7 @@ We extend our gratitude to all the ITK community members who have contributed to
 🗣️ What's Next
 ---------------
 
-ITK 5.4.0 represents a transformative milestone in our documentation journey. The finalization of 5.4.0 was delayed due to dependency issues in the example documentation's infrastructure. While these are addressed, we'll continue to refine the 5.4 series through patch releases. We're excited to eventually migrate the examples to a similar robust foundation in future innovations. 
+ITK 5.4.0 represents a transformative milestone in our documentation journey. The finalization of 5.4.0 was delayed due to dependency issues in the example documentation's infrastructure. While these are addressed, we'll continue to refine the 5.4 series through patch releases. We're excited to eventually migrate the examples to a similar robust foundation in future innovations.
 
 Looking ahead, we're thrilled to announce that ITK 6, our next major release, will showcase a substantial array of modernizations. The community has been hard at work implementing significant improvements that will elevate development with and on the toolkit. Watch for upcoming alpha and beta releases of ITK 6, which will run parallel to our 5.4 maintenance efforts.
 

Examples/.clang-format

@@ -1,4 +1,4 @@
-## This config file is only relevant for clang-format version 19.1.4
+## This config file is only relevant for clang-format version 19.1.7
 ##
 ## Examples of each format style can be found on the in the clang-format documentation
 ## See: https://clang.llvm.org/docs/ClangFormatStyleOptions.html for details of each option
@@ -10,11 +10,11 @@
 ## maintaining a consistent code style.
 ##
 ## EXAMPLE apply code style enforcement before commit:
-#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.4} --modified
+#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.7} --modified
 ## EXAMPLE apply code style enforcement after commit:
-#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.4} --last
+#     Utilities/Maintenance/clang-format.bash --clang ${PATH_TO_CLANG_FORMAT_19.1.7} --last
 ---
-# This configuration requires clang-format version 19.1.4 exactly.
+# This configuration requires clang-format version 19.1.7 exactly.
 Language:        Cpp
 AccessModifierOffset: -2
 AlignAfterOpenBracket: Align

Modules/Core/Common/include/itkBufferedImageNeighborhoodPixelAccessPolicy.h

@@ -126,7 +126,6 @@ class BufferedImageNeighborhoodPixelAccessPolicy final
   {
     m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
   }
-
 };
 
 } // namespace itk

Modules/Core/Common/include/itkCommonEnums.h

@@ -212,8 +212,8 @@ class OctreeEnums
    */
   enum class Octree : uint8_t
   {
-    UNKNOWN_PLANE,   ///< The plane is Unknown
-    SAGITTAL_PLANE,  ///< The plane is Sagittal
+    UNKNOWN_PLANE,  ///< The plane is Unknown
+    SAGITTAL_PLANE, ///< The plane is Sagittal
 #if !defined(ITK_LEGACY_REMOVE)
     SAGITAL_PLANE [[deprecated("Use SAGITTAL_PLANE instead")]] = SAGITTAL_PLANE, ///< Support misspelling
 #endif

Modules/Core/Common/include/itkConnectedImageNeighborhoodShape.h

@@ -248,7 +248,6 @@ class ConnectedImageNeighborhoodShape
   {
     return (includeCenterPixel ? 1 : 0) + CalculateNumberOfConnectedNeighbors(maximumCityblockDistance);
   }
-
 };
 
 /** Generates the offsets for a connected image neighborhood shape. */

Modules/Core/Common/include/itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h

@@ -144,7 +144,6 @@ class ConstantBoundaryImageNeighborhoodPixelAccessPolicy final
       m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
     }
   }
-
 };
 
 } // namespace itk

Modules/Core/Common/include/itkContinuousIndex.h

@@ -90,7 +90,6 @@ class ITK_TEMPLATE_EXPORT ContinuousIndex : public Point<TCoordinate, VIndexDime
       (*this)[i] = static_cast<TCoordinate>(index[i]);
     }
   }
-
 };
 } // namespace itk