update readme #14
This file contains hidden or 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
| name: Continuous Integration | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: { python-version: "3.12" } | |
| - name: Install codespell | |
| run: pip3 install codespell | |
| - name: Lint | |
| run: cmake -D FORMAT_COMMAND=clang-format-18 -P cmake/lint.cmake | |
| - name: Spell check | |
| if: always() | |
| run: cmake -P cmake/spell.cmake | |
| coverage: | |
| needs: [lint] | |
| runs-on: ubuntu-24.04 | |
| # To enable coverage, delete the last line from the conditional below and | |
| # edit the "<name>" placeholder to your GitHub name. | |
| # If you do not wish to use codecov, then simply delete this job from the | |
| # workflow. | |
| if: github.repository_owner == '<name>' | |
| && false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install LCov | |
| run: sudo apt-get update -q | |
| && sudo apt-get install lcov -q -y | |
| - name: Configure | |
| run: cmake --preset=ci-coverage | |
| - name: Build | |
| run: cmake --build build/coverage -j 2 | |
| - name: Test | |
| working-directory: build/coverage | |
| run: ctest --output-on-failure --no-tests=error -j 2 | |
| - name: Process coverage info | |
| run: cmake --build build/coverage -t coverage | |
| - name: Submit to codecov.io | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| file: build/coverage/coverage.info | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| sanitize: | |
| needs: [lint] | |
| runs-on: ubuntu-24.04 | |
| env: { CXX: clang++-18 } | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Configure | |
| run: cmake --preset=ci-sanitize | |
| - name: Build | |
| run: cmake --build build/sanitize -j 2 | |
| - name: Test | |
| working-directory: build/sanitize | |
| env: | |
| ASAN_OPTIONS: "strict_string_checks=1:\ | |
| detect_stack_use_after_return=1:\ | |
| check_initialization_order=1:\ | |
| strict_init_order=1:\ | |
| detect_leaks=1:\ | |
| halt_on_error=1" | |
| UBSAN_OPTIONS: "print_stacktrace=1:\ | |
| halt_on_error=1" | |
| run: ctest --output-on-failure --no-tests=error -j 2 | |
| test: | |
| needs: [lint] | |
| strategy: | |
| matrix: | |
| os: [macos-14, ubuntu-24.04, windows-2022] | |
| type: [shared, static] | |
| include: | |
| - { type: shared, shared: YES } | |
| - { type: static, shared: NO } | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install static analyzers | |
| if: matrix.os == 'ubuntu-24.04' | |
| run: | | |
| while sudo fuser /var/lib/dpkg/lock-frontend; do | |
| echo "Waiting for other apt processes to finish..." | |
| sleep 1 | |
| done | |
| sudo apt-get install clang-tidy-18 cppcheck -y -q | |
| sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-18 180 | |
| - name: Setup MultiToolTask | |
| if: matrix.os == 'windows-2022' | |
| run: | | |
| Add-Content "$env:GITHUB_ENV" 'UseMultiToolTask=true' | |
| Add-Content "$env:GITHUB_ENV" 'EnforceProcessCountAcrossBuilds=true' | |
| - name: Configure | |
| shell: pwsh | |
| run: cmake "--preset=ci-$("${{ matrix.os }}".split("-")[0])" | |
| -D BUILD_SHARED_LIBS=${{ matrix.shared }} | |
| - name: Setup PATH | |
| if: matrix.os == 'windows-2022' && matrix.type == 'shared' | |
| run: Add-Content "$env:GITHUB_PATH" "$(Get-Location)\build\Release" | |
| - name: Build | |
| run: cmake --build build --config Release -j 2 | |
| - name: Install | |
| run: cmake --install build --config Release --prefix prefix | |
| - name: Test | |
| working-directory: build | |
| run: ctest --output-on-failure --no-tests=error -C Release -j 2 |