lint.yml

# Eggs.Stacktrace
#
# Copyright (c) 2026 Agustin Berge
#
# Distributed under the Boost Software License, Version 1.0.
# See accompanying file LICENSE.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt

name: lint

on:
  push:
    branches: [ main, feature/** ]
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  orphan-sources-configure:
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest]

    runs-on: ${{ matrix.os }}

    steps:
      - uses: actions/checkout@v5

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: "4.4.0"

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      - name: Enable CMake File API (codemodel-v2)
        shell: bash
        run: |
          mkdir -p build/lint/.cmake/api/v1/query
          touch build/lint/.cmake/api/v1/query/codemodel-v2

      - name: Configure
        run: cmake -S . -B build/lint

      - name: Record referenced source files
        run: python .github/scripts/lint/check_orphan_sources.py --dump-referenced referenced-${{ matrix.os }}.json build/lint

      - uses: actions/upload-artifact@v6
        with:
          name: orphan-sources-referenced-${{ matrix.os }}
          path: referenced-${{ matrix.os }}.json
          if-no-files-found: error

  orphan-sources:
    needs: orphan-sources-configure
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v5

      - uses: actions/download-artifact@v7
        with:
          pattern: orphan-sources-referenced-*
          path: referenced
          merge-multiple: true

      - name: Check every header/source file is referenced by a CMake target on some platform
        run: python3 .github/scripts/lint/check_orphan_sources.py referenced/*.json

  clang-tidy:
    name: clang-tidy (clang-22)
    runs-on: ubuntu-24.04
    timeout-minutes: 10

    env:
      EGGS_STACKTRACE_SOURCE_DIR: ${{ github.workspace }}

    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: "4.4.0"

      - name: Set up APT package cache
        run: |
          mkdir -p ~/.cache/apt/archives/partial
          echo "Dir::Cache::archives \"$HOME/.cache/apt/archives\";" \
            | sudo tee /etc/apt/apt.conf.d/99user-cache

      - name: Cache APT packages
        continue-on-error: true
        uses: actions/cache@v5
        with:
          path: ~/.cache/apt/archives
          key: apt-ubuntu-24.04-clang-tidy-22-${{ hashFiles('.github/workflows/lint.yml') }}
          restore-keys: apt-ubuntu-24.04-clang-tidy-22-

      - name: Install Clang 22 + clang-tidy
        run: |
          wget -q https://apt.llvm.org/llvm.sh
          sudo bash llvm.sh 22
          sudo apt-get install -y clang-tidy-22
          sudo update-alternatives --install /usr/bin/clang      clang      /usr/bin/clang-22      200
          sudo update-alternatives --install /usr/bin/clang++    clang++    /usr/bin/clang++-22    200
          sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-22 200

      - name: Fix APT cache permissions
        if: always()
        run: sudo rm -rf ~/.cache/apt/archives/lock ~/.cache/apt/archives/partial

      - name: Configure
        run: cmake --preset dev-clang -B build/clang-tidy

      - name: Run clang-tidy
        run: python3 .github/scripts/lint/clang-tidy-run.py
               build/clang-tidy build/clang-tidy/clang-tidy.sarif

      - name: Upload SARIF
        uses: actions/upload-artifact@v6
        with:
          name: clang-tidy.sarif
          path: build/clang-tidy/clang-tidy.sarif
          retention-days: 7

      - name: Determine diff base
        id: diff-base
        run: |
          if [ "${{ github.ref }}" = "refs/heads/main" ]; then
            if git rev-parse --verify -q HEAD^ > /dev/null; then
              echo "ref=HEAD^" >> "$GITHUB_OUTPUT"
            fi
          else
            git fetch origin main
            echo "ref=origin/main" >> "$GITHUB_OUTPUT"
          fi

      - name: Check warnings on changed lines
        if: steps.diff-base.outputs.ref != ''
        run: python3 .github/scripts/lint/warn-everything-check-changed.py
               build/clang-tidy/clang-tidy.sarif ${{ steps.diff-base.outputs.ref }} clang-tidy

  clang-tidy-win32:
    name: clang-tidy win32 (clang-22)
    runs-on: windows-2025-vs2026
    timeout-minutes: 15

    env:
      EGGS_STACKTRACE_SOURCE_DIR: ${{ github.workspace }}

    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: "4.4.0"

      - name: Install LLVM 22
        run: choco upgrade llvm --version=22.1.0 --allow-downgrade -y --no-progress

      - name: Set up MSVC environment
        shell: pwsh
        run: |
          $vsPath = & "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe" `
              -latest -property installationPath
          $vcvars = "$vsPath\VC\Auxiliary\Build\vcvars64.bat"
          cmd /c "`"$vcvars`" && set" | ForEach-Object {
            if ($_ -match '^([^=]+)=(.*)$') {
              "$($Matches[1])=$($Matches[2])" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
            }
          }
          # Ahead of any clang-tidy bundled with Visual Studio.
          "C:\Program Files\LLVM\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append

      - name: Configure
        run: |
          clang-tidy --version
          cmake --preset dev-msvc -B build/clang-tidy

      - name: Run clang-tidy
        run: python .github/scripts/lint/clang-tidy-run.py
               build/clang-tidy build/clang-tidy/clang-tidy.sarif

      - name: Upload SARIF
        uses: actions/upload-artifact@v6
        with:
          name: clang-tidy-win32.sarif
          path: build/clang-tidy/clang-tidy.sarif
          retention-days: 7

      - name: Determine diff base
        id: diff-base
        shell: bash
        run: |
          if [ "${{ github.ref }}" = "refs/heads/main" ]; then
            if git rev-parse --verify -q HEAD^ > /dev/null; then
              echo "ref=HEAD^" >> "$GITHUB_OUTPUT"
            fi
          else
            git fetch origin main
            echo "ref=origin/main" >> "$GITHUB_OUTPUT"
          fi

      - name: Check warnings on changed lines
        if: steps.diff-base.outputs.ref != ''
        run: python .github/scripts/lint/warn-everything-check-changed.py
               build/clang-tidy/clang-tidy.sarif ${{ steps.diff-base.outputs.ref }} clang-tidy-win32

  warn-everything:
    name: -Weverything (clang-22)
    runs-on: ubuntu-24.04
    timeout-minutes: 6

    env:
      EGGS_STACKTRACE_SOURCE_DIR: ${{ github.workspace }}

    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: "4.4.0"

      - name: Set up APT package cache
        run: |
          mkdir -p ~/.cache/apt/archives/partial
          echo "Dir::Cache::archives \"$HOME/.cache/apt/archives\";" \
            | sudo tee /etc/apt/apt.conf.d/99user-cache

      - name: Cache APT packages
        continue-on-error: true
        uses: actions/cache@v5
        with:
          path: ~/.cache/apt/archives
          key: apt-ubuntu-24.04-clang-22-${{ hashFiles('.github/workflows/lint.yml') }}
          restore-keys: apt-ubuntu-24.04-clang-22-

      - name: Install Clang 22
        run: |
          wget -q https://apt.llvm.org/llvm.sh
          sudo bash llvm.sh 22
          sudo update-alternatives --install /usr/bin/clang   clang   /usr/bin/clang-22   200
          sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-22 200

      - name: Install libstdc++-16
        run: |
          sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
          sudo apt-get update
          sudo apt-get install -y g++-16

      - name: Fix APT cache permissions
        if: always()
        run: sudo rm -rf ~/.cache/apt/archives/lock ~/.cache/apt/archives/partial

      - name: Configure
        run: cmake --preset dev-clang -B build/warn-everything
               -DCMAKE_COMPILE_WARNING_AS_ERROR=OFF
               -DCMAKE_CXX_COMPILER_LAUNCHER="python3;${{ github.workspace }}/.github/scripts/lint/warn-everything-launcher.py"
               -DCMAKE_CXX_FLAGS_INIT="--gcc-install-dir=/usr/lib/gcc/x86_64-linux-gnu/16
                 -Weverything
                 -Wno-c++98-compat -Wno-c++98-compat-pedantic
                 -Wno-c++11-compat
                 -Wno-c++14-compat
                 -Wno-pre-c++14-compat -Wno-pre-c++14-compat-pedantic
                 -Wno-c++17-compat -Wno-c++17-compat-mangling
                 -Wno-pre-c++17-compat -Wno-pre-c++17-compat-pedantic
                 -Wno-c++20-compat
                 -Wno-pre-c++20-compat -Wno-pre-c++20-compat-pedantic
                 -Wno-pre-c++23-compat -Wno-pre-c++23-compat-pedantic
                 -Wno-unsafe-buffer-usage"

      - name: Build (Debug)
        run: cmake --build build/warn-everything --config Debug -- -k 0

      - name: Merge SARIF fragments
        run: python3 .github/scripts/lint/warn-everything-merge-sarif.py
               build/warn-everything build/warn-everything/warn-everything.sarif

      - name: Upload SARIF
        uses: actions/upload-artifact@v6
        with:
          name: warn-everything.sarif
          path: build/warn-everything/warn-everything.sarif
          retention-days: 7

      - name: Determine diff base
        id: diff-base
        run: |
          if [ "${{ github.ref }}" = "refs/heads/main" ]; then
            if git rev-parse --verify -q HEAD^ > /dev/null; then
              echo "ref=HEAD^" >> "$GITHUB_OUTPUT"
            fi
          else
            git fetch origin main
            echo "ref=origin/main" >> "$GITHUB_OUTPUT"
          fi

      - name: Check warnings on changed lines
        if: steps.diff-base.outputs.ref != ''
        run: python3 .github/scripts/lint/warn-everything-check-changed.py
               build/warn-everything/warn-everything.sarif ${{ steps.diff-base.outputs.ref }}

      - name: Check warnings from headers
        run: python3 .github/scripts/lint/warn-everything-check-headers.py
               build/warn-everything/warn-everything.sarif

  include-cleaner:
    name: clang-include-cleaner (clang-22)
    runs-on: ubuntu-24.04
    timeout-minutes: 5

    steps:
      - uses: actions/checkout@v5

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: "4.4.0"

      - name: Set up APT package cache
        run: |
          mkdir -p ~/.cache/apt/archives/partial
          echo "Dir::Cache::archives \"$HOME/.cache/apt/archives\";" \
            | sudo tee /etc/apt/apt.conf.d/99user-cache

      - name: Cache APT packages
        continue-on-error: true
        uses: actions/cache@v5
        with:
          path: ~/.cache/apt/archives
          key: apt-ubuntu-24.04-clang-tools-22-${{ hashFiles('.github/workflows/lint.yml') }}
          restore-keys: apt-ubuntu-24.04-clang-tools-22-

      - name: Install Clang 22
        run: |
          wget -q https://apt.llvm.org/llvm.sh
          sudo bash llvm.sh 22
          sudo apt-get install -y clang-tools-22
          sudo update-alternatives --install /usr/bin/clang   clang   /usr/bin/clang-22   200
          sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-22 200
          sudo update-alternatives --install /usr/bin/clang-include-cleaner \
            clang-include-cleaner /usr/bin/clang-include-cleaner-22 200

      - name: Install libstdc++-16
        run: |
          sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
          sudo apt-get update
          sudo apt-get install -y g++-16

      - name: Fix APT cache permissions
        if: always()
        run: sudo rm -rf ~/.cache/apt/archives/lock ~/.cache/apt/archives/partial

      - name: Configure
        run: cmake --preset dev-clang -B build/include-cleaner
               -DCMAKE_CXX_FLAGS_INIT=--gcc-install-dir=/usr/lib/gcc/x86_64-linux-gnu/16

      - name: Check includes
        run: python3 .github/scripts/lint/check_include_cleaner.py build/include-cleaner