Update pre-commit config (#270) #1146
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
| # Copyright (C) 2022 Roberto Rossini <[email protected]> | |
| # SPDX-License-Identifier: MIT | |
| name: Run clang-tidy | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/build-conan-deps.yml" | |
| - ".github/workflows/evict-gha-cache.yml" | |
| - ".github/workflows/build-project.yml" | |
| - "cmake/**" | |
| - "examples/**" | |
| - "src/**" | |
| - "test/units/**" | |
| - ".clang-tidy" | |
| - "CMakeLists.txt" | |
| - "conanfile.py" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/build-conan-deps.yml" | |
| - ".github/workflows/evict-gha-cache.yml" | |
| - ".github/workflows/build-project.yml" | |
| - "cmake/**" | |
| - "examples/**" | |
| - "src/**" | |
| - "test/units/**" | |
| - ".clang-tidy" | |
| - "CMakeLists.txt" | |
| - "conanfile.py" | |
| # https://stackoverflow.com/a/72408109 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| build-conan-deps: | |
| name: Build Conan deps | |
| uses: paulsengroup/hictk/.github/workflows/build-conan-deps.yml@main | |
| with: | |
| os: ubuntu-20.04 | |
| build-project: | |
| name: Build project | |
| needs: build-conan-deps | |
| runs-on: ubuntu-latest | |
| container: | |
| image: ghcr.io/paulsengroup/ci-docker-images/ubuntu-24.04-cxx-clang-18 | |
| options: "--user=root" | |
| outputs: | |
| ccache-old-cache-key: ${{ steps.cache-ccache.outputs.cache-matched-key }} | |
| env: | |
| CCACHE_DIR: "/opt/ccache-cache" | |
| CCACHE_COMPRESSLEVEL: "1" | |
| CCACHE_MAXSIZE: "300M" | |
| CONAN_HOME: "/opt/conan/" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Fix permissions | |
| run: | | |
| chown -R $(id -u):$(id -g) $PWD | |
| - name: Print clang-tidy version | |
| run: clang-tidy --version | |
| - name: Generate cache key | |
| id: cache-key | |
| run: | | |
| conanfile_hash="${{ hashFiles('conanfile.py') }}" | |
| # This can be used by to always update a cache entry (useful e.g. for ccache) | |
| current_date="$(date '+%s')" | |
| ccache_key_prefix="ccache-clang-tidy-$conanfile_hash" | |
| echo "ccache-key=${ccache_key_prefix}-$GITHUB_REF-${current_date}" | tee -a "$GITHUB_OUTPUT" | |
| echo "ccache-restore-key-1=$ccache_key_prefix-$GITHUB_REF" | tee -a "$GITHUB_OUTPUT" | |
| echo "ccache-restore-key-2=$ccache_key_prefix" | tee -a "$GITHUB_OUTPUT" | |
| - name: Restore Conan cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: ${{ needs.build-conan-deps.outputs.conan-key }} | |
| path: ${{ env.CONAN_HOME }}/p | |
| fail-on-cache-miss: true | |
| - name: Restore CMake configs | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: ${{ needs.build-conan-deps.outputs.cmake-prefix-debug-key }} | |
| path: /tmp/cmake-prefix-dbg.tar | |
| fail-on-cache-miss: true | |
| - name: Extract CMake configs | |
| run: | | |
| mkdir conan-env | |
| tar -xf /tmp/cmake-prefix-dbg.tar -C conan-env/ --strip-components=1 | |
| - name: Configure project | |
| run: | | |
| cmake -DCMAKE_BUILD_TYPE=Debug \ | |
| -DCMAKE_PREFIX_PATH="$PWD/conan-env" \ | |
| -DENABLE_DEVELOPER_MODE=ON \ | |
| -DOPT_ENABLE_SANITIZER_ADDRESS=OFF \ | |
| -DOPT_ENABLE_SANITIZER_UNDEFINED_BEHAVIOR=OFF \ | |
| -DOPT_ENABLE_CLANG_TIDY=ON \ | |
| -DHICTK_BUILD_EXAMPLES=ON \ | |
| -DHICTK_ENABLE_TESTING=ON \ | |
| -DHICTK_DOWNLOAD_TEST_DATASET=OFF \ | |
| -DHICTK_ENABLE_GIT_VERSION_TRACKING=OFF \ | |
| -S . \ | |
| -B build | |
| - name: Restore Ccache folder | |
| id: cache-ccache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| key: ${{ steps.cache-key.outputs.ccache-restore-key-1 }} | |
| restore-keys: ${{ steps.cache-key.outputs.ccache-restore-key-2 }} | |
| path: ${{ env.CCACHE_DIR }} | |
| - name: Reset Ccache stats | |
| run: ccache --zero-stats | |
| - name: Build project | |
| run: cmake --build build -j $(nproc) | |
| - name: Print Ccache statistics (pre-cleanup) | |
| run: | | |
| ccache --show-stats \ | |
| --show-compression \ | |
| --verbose | |
| - name: Cleanup Ccache folder | |
| run: | | |
| ccache --evict-older-than=14400s # 4h | |
| ccache --recompress=19 --recompress-threads="$(nproc)" | |
| ccache --cleanup | |
| - name: Print Ccache statistics (post-cleanup) | |
| run: | | |
| ccache --show-stats \ | |
| --show-compression \ | |
| --verbose | |
| - name: Save Ccache folder | |
| uses: actions/cache/save@v4 | |
| with: | |
| key: ${{ steps.cache-key.outputs.ccache-key }} | |
| path: ${{ env.CCACHE_DIR }} | |
| env: | |
| ZSTD_CLEVEL: 1 | |
| clean-stale-cache: | |
| needs: [build-project] | |
| uses: paulsengroup/hictk/.github/workflows/evict-gha-cache.yml@main | |
| name: Clean stale Ccache cache | |
| permissions: | |
| actions: write | |
| if: needs.build-project.outputs.ccache-old-cache-key != '' | |
| with: | |
| cache-key: "${{ needs.build-project.outputs.ccache-old-cache-key }}" | |
| clang-tidy-status-check: | |
| name: Status Check (clang-tidy) | |
| if: ${{ always() }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build-project | |
| steps: | |
| - name: Collect job results | |
| if: needs.build-project.result != 'success' | |
| run: exit 1 |