unix.yml

name: Unix Build

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  formatting:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4

      - name: Install clang-format
        env:
          DEBIAN_FRONTEND: noninteractive
        run: |
          wget https://apt.llvm.org/llvm.sh
          chmod +x llvm.sh
          sudo ./llvm.sh 18
          rm llvm.sh
          sudo apt-get install -y --no-install-recommends clang-format-18
      - name: Format files
        run: find test include -type f -not -name catch.hpp -a \( -name "*.cc" -o -name "*.h" \) -print0 | xargs -0 clang-format-18 -i

      - name: Check for differences
        run: |
          git status --porcelain
          git status --porcelain | xargs -I {} -0 test -z \"{}\"

  build:
    runs-on: ${{ matrix.config.os }}
    strategy:
      fail-fast: false
      matrix:
        config:
          - name: MacOS Release
            cxx: clang++
            cc: clang
            mode: Release
            cxxflags: -stdlib=libc++
            os: macos-latest
          - name: GCC 12 Release
            cxx: g++-12
            cc: gcc-12
            mode: Release
            os: ubuntu-24.04
          - name: GCC 12 Release
            cxx: g++-12
            cc: gcc-12
            mode: Release
            os: ubuntu-24.04
          - name: GCC 12 Debug
            cxx: g++-12
            cc: gcc-12
            mode: Debug
            os: ubuntu-24.04
          - name: Clang 18 Release
            cxx: clang++-18
            cc: clang-18
            mode: Release
            cxxflags: -stdlib=libc++
            ldflags: -lc++abi
            os: ubuntu-24.04
          - name: Clang Tidy
            cxx: clang++-18
            cc: clang-18
            mode: Debug
            cxxflags: -stdlib=libc++
            ldflags: -lc++abi
            lint: true
            os: ubuntu-24.04
          - key: GCC 12 Sanitizer
            cxx: g++-12
            cc: gcc-12
            mode: Release
            cflags: -fsanitize=address,undefined -fno-omit-frame-pointer
            cxxflags: -fsanitize=address,undefined -fno-omit-frame-pointer
            os: ubuntu-24.04
    env:
      DEBIAN_FRONTEND: noninteractive
      UBSAN_OPTIONS: halt_on_error=1:abort_on_error=1
    steps:
      - uses: actions/checkout@v4

      - uses: seanmiddleditch/gha-setup-ninja@master
        if: matrix.config.os == 'macos-latest'

      - name: Install doxygen 🔧
        uses: ssciwr/doxygen-install@v1
        with:
          version: "1.13.2"

      # ==== INSTALL ====
      - name: Update APT
        if: matrix.config.os != 'macos-latest'
        run: sudo apt-get update

      - name: Install LLVM
        if: matrix.config.os != 'macos-latest' && matrix.config.cc == 'clang-18'
        run: |
          wget https://apt.llvm.org/llvm.sh
          chmod +x llvm.sh
          sudo ./llvm.sh 18
          rm llvm.sh
          sudo apt-get install -y --no-install-recommends libc++-18-dev libc++abi-18-dev clang-tidy-18 libunwind-18-dev llvm-18

      - name: Install Valgrind
        if: matrix.config.mode == 'Debug' && matrix.config.cc == 'gcc-12'
        run: sudo apt-get install -y --no-install-recommends valgrind

      - name: Install Ninja
        if: matrix.config.os != 'macos-latest'
        run: sudo apt-get install -y --no-install-recommends ninja-build

      # ==== BUILD ====
      - name: CMake
        run: |
          cmake \
            -G Ninja -S . -B build \
            -DCMAKE_C_COMPILER=${{ matrix.config.cc }} \
            -DCMAKE_CXX_COMPILER=${{ matrix.config.cxx }} \
            -DCMAKE_C_FLAGS="${{ matrix.config.cflags }}" \
            -DCMAKE_CXX_FLAGS="${{ matrix.config.cxxflags }}" \
            -DCMAKE_CXX_FLAGS_DEBUG="" \
            -DCMAKE_CXX_LINKER_FLAGS=${{ matrix.config.ldflags }}" \
            -DCMAKE_CXX_EXE_LINKER_FLAGS="${{ matrix.config.ldflags }} \
            -DCMAKE_BUILD_TYPE=${{ matrix.config.mode }} \
            -UTL_LINT=${{ matrix.config.lint }}
      - name: Build
        run: |
          cmake --build build --target utl-test

      # ==== TESTS ====
      - name: Run Tests
        run: ./build/utl-test

      # ==== VALGRIND ====
      - name: Run Tests Valgrind
        if: matrix.config.mode == 'Debug' && matrix.config.cc == 'gcc-12'
        run: valgrind --error-exitcode=1 --show-reachable=yes --leak-check=full ./build/utl-test

  doc:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4

      - name: Set up Python 3.13 🔧
        uses: actions/setup-python@v5
        with:
          python-version: 3.13

      - name: Install doxygen 🔧
        uses: ssciwr/doxygen-install@v1
        with:
          version: "1.13.2"

      - name: Install Python dependencies ⚙️
        run: pip install -r docs/requirements.txt

      - name: Generate HTML documentation 🏗️
        run: |
          cd docs
          doxygen
          sphinx-build -M html . _build
          mv _build/html ../public

      - name: Deploy documentation onto GitHub Pages 🚀
        if: github.ref == 'refs/heads/master'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: public/