Drafting updates to template #9
Workflow file for this run
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
| name: Linter - Continuous Integration | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'linter/**' | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - 'linter/**' | |
| workflow_dispatch: | |
| # We only care about the latest revision of a PR, so cancel all previous instances. | |
| concurrency: | |
| group: linter-ci-${{ github.event.pull_request.number || github.ref_name }} | |
| cancel-in-progress: true | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-22.04 | |
| defaults: | |
| run: | |
| working-directory: linter | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - uses: actions/setup-python@v4 | |
| with: { python-version: "3.11" } | |
| - name: Install LLVM 17 | |
| run: | | |
| wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc | |
| sudo apt-add-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" | |
| sudo apt update | |
| sudo apt install llvm-17 llvm-17-dev llvm-17-tools clang-17 clang-tidy-17 clang-format-17 clang-tools-17 libclang-17-dev -y | |
| - name: Install codespell | |
| run: pip3 install codespell | |
| - name: Lint | |
| run: cmake -D FORMAT_COMMAND=clang-format-17 -P cmake/lint.cmake | |
| - name: Spell check | |
| run: cmake -P cmake/spell.cmake | |
| sanitize: | |
| needs: [lint] | |
| runs-on: ubuntu-22.04 | |
| defaults: | |
| run: | |
| working-directory: linter | |
| env: | |
| CC: clang-17 | |
| CXX: clang++-17 | |
| CLANG_DIR: '/usr/lib/llvm-17/lib/cmake/clang' | |
| LLVM_DIR: '/usr/lib/llvm-17/lib/cmake/llvm' | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - name: Install Python | |
| uses: actions/setup-python@v4 | |
| with: { python-version: "3.11" } | |
| - name: Install Python Developer Headers | |
| run: sudo apt install python3.11-dev | |
| - name: Install LLVM 17 | |
| run: | | |
| wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc | |
| sudo apt-add-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" | |
| sudo apt update | |
| sudo apt install llvm-17 llvm-17-dev llvm-17-tools clang-17 clang-tidy-17 clang-tools-17 libclang-17-dev -y | |
| - name: Install dependencies | |
| run: | | |
| pip3 install conan | |
| sudo apt install libssl-dev -y | |
| bash < ../.github/scripts/conan-profile.sh | |
| conan install . -s build_type=Release -b missing | |
| - name: Configure | |
| run: cmake --preset=ci-sanitize | |
| - name: Build | |
| run: cmake --build build/sanitize -j 2 | |
| - name: Test | |
| working-directory: linter/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" | |
| UBSAN_OPTIONS: print_stacktrace=1 | |
| run: ctest --output-on-failure --no-tests=error -j 2 | |
| test: | |
| needs: [lint] | |
| strategy: | |
| matrix: | |
| os: [ubuntu-22.04] | |
| runs-on: ${{ matrix.os }} | |
| defaults: | |
| run: | |
| working-directory: linter | |
| env: | |
| CC: clang-17 | |
| CXX: clang++-17 | |
| CLANG_DIR: '/usr/lib/llvm-17/lib/cmake/clang' | |
| LLVM_DIR: '/usr/lib/llvm-17/lib/cmake/llvm' | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - name: Install LLVM 17 | |
| run: | | |
| wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc | |
| sudo apt-add-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main" | |
| sudo apt update | |
| sudo apt install llvm-17 llvm-17-dev llvm-17-tools clang-17 clang-tidy-17 clang-tools-17 libclang-17-dev -y | |
| - name: Install static analyzers | |
| if: matrix.os == 'ubuntu-22.04' | |
| run: >- | |
| sudo apt install cppcheck -y -q | |
| sudo update-alternatives --install | |
| /usr/bin/clang-tidy clang-tidy | |
| /usr/bin/clang-tidy-17 160 | |
| - name: Install Python | |
| uses: actions/setup-python@v4 | |
| with: { python-version: "3.11" } | |
| - name: Install Python Developer Headers | |
| run: sudo apt install python3.11-dev | |
| - name: Install dependencies | |
| shell: bash | |
| run: | | |
| pip3 install conan | |
| sudo apt install libssl-dev -y | |
| bash < ../.github/scripts/conan-profile.sh | |
| conan install . -s build_type=Release -b missing | |
| - 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])" | |
| - name: Build | |
| run: cmake --build build --config Release -j 2 | |
| - name: Install | |
| run: cmake --install build --config Release --prefix prefix | |
| - name: Test | |
| working-directory: linter/build | |
| run: ctest --output-on-failure --no-tests=error -C Release -j 2 | |
| docs: | |
| # Deploy docs only when builds succeed | |
| needs: [sanitize, test] | |
| runs-on: ubuntu-22.04 | |
| defaults: | |
| run: | |
| working-directory: linter | |
| # To enable, first you have to create an orphaned gh-pages branch: | |
| # | |
| # git switch --orphan gh-pages | |
| # git commit --allow-empty -m "Initial commit" | |
| # git push -u origin gh-pages | |
| # | |
| # Edit the <name> placeholder below to your GitHub name, so this action | |
| # runs only in your repository and no one else's fork. After these, delete | |
| # this comment and the last line in the conditional below. | |
| # If you do not wish to use GitHub Pages for deploying documentation, then | |
| # simply delete this job similarly to the coverage one. | |
| if: github.ref == 'refs/heads/main' | |
| && github.event_name == 'push' | |
| && github.repository_owner == 'northwesternfintech' | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - uses: actions/setup-python@v4 | |
| with: { python-version: "3.11" } | |
| - name: Install m.css dependencies | |
| run: pip3 install jinja2 Pygments | |
| - name: Install Doxygen | |
| run: sudo apt update -q | |
| && sudo apt install doxygen -q -y | |
| - name: Build docs | |
| run: cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build" | |
| -P cmake/docs-ci.cmake | |
| - name: Deploy docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: build/docs/html | |
| create-dockerimage: | |
| needs: [lint] | |
| # dockerimage will compile when deploying on push, so no need to run twice | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-22.04 | |
| defaults: | |
| run: | |
| working-directory: linter | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - name: Copy conan-profile.sh to linter directory | |
| run: cp ../.github/scripts/conan-profile.sh conan-profile.sh | |
| - name: Create Dockerimage | |
| run: docker build -t nutc-linter:latest . | |
| deploy-dockerimage: | |
| needs: [lint, sanitize, test] | |
| # don't want to deploy if PR | |
| if: github.event_name == 'push' | |
| runs-on: ubuntu-22.04 | |
| defaults: | |
| run: | |
| working-directory: linter | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: 'recursive' | |
| - name: Configure gcloud | |
| run: | | |
| gcloud config set project ${{ secrets.GCP_PROJECT_ID }} | |
| gcloud auth configure-docker | |
| - name: Write GCP Service Account Key to File | |
| run: echo "$GCP_SA_KEY" > ../.github/gcp-sa-key.json | |
| env: | |
| GCP_SA_KEY: ${{ secrets.GCP_SA_KEY }} | |
| - name: Authenticate with Google Cloud | |
| run: gcloud auth activate-service-account --key-file=../.github/gcp-sa-key.json | |
| - name: Copy conan-profile.sh to linter directory | |
| run: cp ../.github/scripts/conan-profile.sh conan-profile.sh | |
| - name: Create Dockerimage | |
| run: docker build -t nutc-linter:latest . | |
| - name: Push Docker image | |
| run: | | |
| docker tag nutc-linter:latest gcr.io/${{ secrets.GCP_PROJECT_ID }}/nutc-linter:latest | |
| docker push gcr.io/${{ secrets.GCP_PROJECT_ID }}/nutc-linter:latest | |
| - name: Deploy to Cloud Run | |
| run: > | |
| gcloud run deploy nutc-linter | |
| --image gcr.io/${{ secrets.GCP_PROJECT_ID }}/nutc-linter:latest | |
| --region us-central1 | |
| --platform managed | |