chore: Update CMake configuration to support custom LLVM download directory and enhance GitHub Actions workflow with caching and compiler launcher settings for improved build performance.

Author: BayernMuller

.github/workflows/wheels.yml

@@ -11,25 +11,51 @@ on:
 
 jobs:
   build_wheels:
-    name: Build ${{ matrix.os }} wheels
-    runs-on: ${{ matrix.os }}
+    name: Build ${{ matrix.name }}
+    runs-on: ${{ matrix.runs_on }}
     env:
+      CIBW_BUILD: "cp39-*"
       CMAKE_BUILD_PARALLEL_LEVEL: "4"
+      CTIDY_LLVM_DOWNLOAD_DIR: ${{ github.workspace }}/.cache/llvm-downloads
+      CIBW_ARCHS: ${{ matrix.cibw_archs }}
     strategy:
       fail-fast: false
       matrix:
-        os:
-          - ubuntu-latest
+        include:
+          - name: linux-x86_64
+            runs_on: ubuntu-latest
+            cibw_archs: x86_64
+            use_ccache: true
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
+      - uses: actions/cache@v4
+        with:
+          path: .cache/llvm-downloads
+          key: llvm-downloads-${{ matrix.name }}-${{ hashFiles('pyproject.toml') }}
+      - if: matrix.use_ccache
+        uses: actions/cache@v4
+        with:
+          path: .ccache
+          key: ccache-${{ matrix.name }}-${{ hashFiles('CMakeLists.txt', 'pyproject.toml', 'src/ctidy/**') }}
+          restore-keys: |
+            ccache-${{ matrix.name }}-
+      - if: matrix.use_ccache && startsWith(matrix.runs_on, 'ubuntu')
+        run: sudo apt-get update && sudo apt-get install -y ccache
+      - if: matrix.use_ccache && startsWith(matrix.runs_on, 'macos')
+        run: brew install ccache
+      - if: matrix.use_ccache
+        run: |
+          echo "CCACHE_DIR=$GITHUB_WORKSPACE/.ccache" >> "$GITHUB_ENV"
+          echo "CMAKE_C_COMPILER_LAUNCHER=$(command -v ccache)" >> "$GITHUB_ENV"
+          echo "CMAKE_CXX_COMPILER_LAUNCHER=$(command -v ccache)" >> "$GITHUB_ENV"
       - run: python -m pip install --upgrade cibuildwheel
       - run: python -m cibuildwheel --output-dir wheelhouse
       - uses: actions/upload-artifact@v4
         with:
-          name: wheels-${{ matrix.os }}
+          name: wheels-${{ matrix.name }}
           path: wheelhouse/*.whl
 
   build_sdist:

CMakeLists.txt

@@ -17,6 +17,12 @@ else()
   set(CTIDY_LLVM_BUILD_PARALLEL_LEVEL 4)
 endif()
 
+if(DEFINED ENV{CTIDY_LLVM_DOWNLOAD_DIR} AND NOT "$ENV{CTIDY_LLVM_DOWNLOAD_DIR}" STREQUAL "")
+  set(CTIDY_LLVM_DOWNLOAD_DIR "$ENV{CTIDY_LLVM_DOWNLOAD_DIR}")
+else()
+  set(CTIDY_LLVM_DOWNLOAD_DIR "${CMAKE_BINARY_DIR}/downloads")
+endif()
+
 set(CTIDY_INSTALL_ROOT "${SKBUILD_PLATLIB_DIR}/ctidy/data")
 set(CTIDY_INSTALL_BIN_DIR "${CTIDY_INSTALL_ROOT}/bin")
 set(CTIDY_INSTALL_RESOURCE_DIR
@@ -37,33 +43,33 @@ set(CTIDY_CLANG_APPLY_REPLACEMENTS
 )
 
 set(CTIDY_EXTERNAL_CMAKE_ARGS
-    -DCMAKE_BUILD_TYPE=Release
-    -DBUILD_SHARED_LIBS=OFF
-    -DCLANG_ENABLE_ARCMT=OFF
-    -DCLANG_ENABLE_CLANGD=OFF
-    -DCLANG_ENABLE_STATIC_ANALYZER=ON
-    -DCLANG_INSTALL_SCANBUILD=OFF
-    -DCLANG_INSTALL_SCANVIEW=OFF
-    -DLLVM_BUILD_BENCHMARKS=OFF
-    -DLLVM_BUILD_DOCS=OFF
-    -DLLVM_BUILD_EXAMPLES=OFF
-    -DLLVM_BUILD_RUNTIME=OFF
-    -DLLVM_BUILD_RUNTIMES=OFF
-    -DLLVM_BUILD_TELEMETRY=OFF
-    -DLLVM_BUILD_TESTS=OFF
-    -DLLVM_ENABLE_BINDINGS=OFF
-    -DLLVM_ENABLE_LIBXML2=OFF
-    -DLLVM_ENABLE_PROJECTS:STRING=clang,clang-tools-extra
-    -DLLVM_ENABLE_OCAMLDOC=OFF
-    -DLLVM_ENABLE_ZLIB=OFF
-    -DLLVM_ENABLE_ZSTD=OFF
-    -DLLVM_INCLUDE_BENCHMARKS=OFF
-    -DLLVM_INCLUDE_DOCS=OFF
-    -DLLVM_INCLUDE_EXAMPLES=OFF
-    -DLLVM_INCLUDE_RUNTIMES=OFF
-    -DLLVM_INCLUDE_TESTS=OFF
-    -DLLVM_INCLUDE_UTILS=ON
-    -DLLVM_TARGETS_TO_BUILD=Native
+  -DCMAKE_BUILD_TYPE=Release
+  -DBUILD_SHARED_LIBS=OFF
+  -DCLANG_ENABLE_ARCMT=OFF
+  -DCLANG_ENABLE_CLANGD=OFF
+  -DCLANG_ENABLE_STATIC_ANALYZER=ON
+  -DCLANG_INSTALL_SCANBUILD=OFF
+  -DCLANG_INSTALL_SCANVIEW=OFF
+  -DLLVM_BUILD_BENCHMARKS=OFF
+  -DLLVM_BUILD_DOCS=OFF
+  -DLLVM_BUILD_EXAMPLES=OFF
+  -DLLVM_BUILD_RUNTIME=OFF
+  -DLLVM_BUILD_RUNTIMES=OFF
+  -DLLVM_BUILD_TELEMETRY=OFF
+  -DLLVM_BUILD_TESTS=OFF
+  -DLLVM_ENABLE_BINDINGS=OFF
+  -DLLVM_ENABLE_LIBXML2=OFF
+  -DLLVM_ENABLE_OCAMLDOC=OFF
+  -DLLVM_ENABLE_PROJECTS:STRING=clang,clang-tools-extra
+  -DLLVM_ENABLE_ZLIB=OFF
+  -DLLVM_ENABLE_ZSTD=OFF
+  -DLLVM_INCLUDE_BENCHMARKS=OFF
+  -DLLVM_INCLUDE_DOCS=OFF
+  -DLLVM_INCLUDE_EXAMPLES=OFF
+  -DLLVM_INCLUDE_RUNTIMES=OFF
+  -DLLVM_INCLUDE_TESTS=OFF
+  -DLLVM_INCLUDE_UTILS=ON
+  -DLLVM_TARGETS_TO_BUILD=Native
 )
 
 if(CMAKE_C_COMPILER)
@@ -78,6 +84,14 @@ if(CMAKE_ASM_COMPILER)
   list(APPEND CTIDY_EXTERNAL_CMAKE_ARGS -DCMAKE_ASM_COMPILER:FILEPATH=${CMAKE_ASM_COMPILER})
 endif()
 
+if(DEFINED ENV{CMAKE_C_COMPILER_LAUNCHER} AND NOT "$ENV{CMAKE_C_COMPILER_LAUNCHER}" STREQUAL "")
+  list(APPEND CTIDY_EXTERNAL_CMAKE_ARGS -DCMAKE_C_COMPILER_LAUNCHER:FILEPATH=$ENV{CMAKE_C_COMPILER_LAUNCHER})
+endif()
+
+if(DEFINED ENV{CMAKE_CXX_COMPILER_LAUNCHER} AND NOT "$ENV{CMAKE_CXX_COMPILER_LAUNCHER}" STREQUAL "")
+  list(APPEND CTIDY_EXTERNAL_CMAKE_ARGS -DCMAKE_CXX_COMPILER_LAUNCHER:FILEPATH=$ENV{CMAKE_CXX_COMPILER_LAUNCHER})
+endif()
+
 if(WIN32)
   list(APPEND CTIDY_EXTERNAL_CMAKE_ARGS -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded)
 endif()
@@ -86,6 +100,7 @@ ExternalProject_Add(
   ctidy_llvm
   URL "${CTIDY_LLVM_URL}"
   DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+  DOWNLOAD_DIR "${CTIDY_LLVM_DOWNLOAD_DIR}"
   SOURCE_DIR "${CTIDY_LLVM_SOURCE_DIR}"
   SOURCE_SUBDIR llvm
   BINARY_DIR "${CTIDY_LLVM_BINARY_DIR}"

pyproject.toml

@@ -37,6 +37,7 @@ scripts = { ctidy = "ctidy.cli:main" }
 build-dir = "build/{wheel_tag}"
 cmake.source-dir = "."
 cmake.version = ">=3.20"
+wheel.py-api = "py3"
 wheel.packages = ["src/ctidy"]
 sdist.include = [
   ".github/workflows/*.yml",