Extend readme and vast-front docs #443
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) 2023, Trail of Bits, Inc. | |
| # All rights reserved. | |
| # | |
| # This source code is licensed in accordance with the terms specified in | |
| # the LICENSE file found in the root directory of this source tree. | |
| # | |
| name: Linters | |
| on: | |
| pull_request: | |
| paths-ignore: "docs/**" | |
| jobs: | |
| cpp-linter: | |
| strategy: | |
| matrix: | |
| llvm-version: [17] | |
| image-version: [22.04] | |
| runs-on: ubuntu-${{ matrix.image-version }} | |
| container: | |
| image: | |
| ghcr.io/trailofbits/vast-ubuntu-${{ matrix.image-version }}-llvm-${{ matrix.llvm-version }}-dev:latest | |
| permissions: | |
| actions: write | |
| issues: write | |
| pull-requests: write | |
| packages: read | |
| env: | |
| CMAKE_PREFIX_PATH: "/usr/lib/llvm-${{ matrix.llvm-version }}/lib/cmake/mlir/;/usr/lib/llvm-${{ matrix.llvm-version }}/lib/cmake/clang/" | |
| TOOLCHAIN: ${{ github.workspace }}/cmake/lld.toolchain.cmake | |
| steps: | |
| - name: Remove safety checks for pygit | |
| run: git config --global --add safe.directory '*' | |
| - name: Clone the vast repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| fetch-depth: 1 | |
| - name: Export compile commands | |
| run: cmake --preset ninja-multi-default --toolchain ${TOOLCHAIN} -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} | |
| - name: Install dependencies | |
| run: | | |
| pip3 install clang-tools cpp-linter | |
| clang-tools -i ${{ matrix.llvm-version }} | |
| - name: Run C++ Linters | |
| uses: xlauko/cpp-linter-action@latest | |
| id: linter | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| version: ${{ matrix.llvm-version }} | |
| style: file | |
| database: ./builds/ninja-multi-default/ | |
| lines-changed-only: true | |
| thread-comments: true | |
| step-summary: true | |
| ignore: 'test' | |
| tidy-checks: '' | |
| - name: Report result | |
| if: steps.linter.outputs.checks-failed > 0 | |
| run: | |
| echo "Some files failed the linting checks!" | |
| exit 1 |