pull-request.yml

name: Pull-Request-CI

on:
  pull_request:
    branches: [ "main" ]

env:
    # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
  BUILD_TYPE: Debug

jobs:
  compile_and_test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        compiler: [g++, clang++]

    steps:
      - uses: actions/checkout@v7

      - name: Configure CMake
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_COMPILER=${{ matrix.compiler }} -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

      - name: Compile
        working-directory: ${{github.workspace}}/build
        run: cmake --build .

      - name: Test
        working-directory: ${{github.workspace}}/build
        run: ctest


  coverage:
    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
    # You can convert this to a matrix build if you need cross-platform coverage.
    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
    runs-on: ubuntu-22.04

    steps:
    - uses: actions/checkout@v7

    - name: Install dependencies
      run: sudo apt-get install lcov -y

    - name: Pull CMake modules
      uses: actions/checkout@v7
      with:
        repository: bilke/cmake-modules
        ref: 877bab9dd1b17468c5d939cacaa2ad7ba99d1977
        path: cmake-modules

    - name: Configure CMake
      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DENABLE_COVERAGE=True

    - name: Generate coverage XML
      working-directory: ${{github.workspace}}/build
      run: make ctest_coverage

    - name: Upload coverage report
      uses: codecov/codecov-action@v7
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./build/ctest_coverage.info
        verbose: true # optional (default = false)

  format:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v7

      - name: clang-format
        uses: jidicula/clang-format-action@v4.18.0
        with:
          clang-format-version: '15'

  verify_documentation:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v7

      # Node is required for npm
      - name: Set up Node
        uses: actions/setup-node@v7
        with:
          node-version: "18"

      - name: Build Docusaurus website
        run: |
          cd docs
          npm install 
          npm run build

  verify_fetchcontent:
    # Graaf is commonly consumed via FetchContent. This builds a minimal
    # standalone project that does exactly that, to catch regressions in our
    # own CMakeLists.txt that only surface when Graaf is a subproject rather
    # than top-level (see #310/#312).
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v7

      - name: Configure consumer project
        run: cmake -B ${{github.workspace}}/consumer-build -S ${{github.workspace}}/cmake_integration/consumer -DGRAAF_SOURCE_DIR=${{github.workspace}}

      - name: Build consumer project
        run: cmake --build ${{github.workspace}}/consumer-build

      - name: Run consumer executable
        run: ${{github.workspace}}/consumer-build/consumer

      - name: Install consumer project
        run: cmake --install ${{github.workspace}}/consumer-build --prefix ${{github.workspace}}/consumer-install

      - name: Verify no pkgconfig file leaked from the FetchContent dependency
        run: |
          if [ -f "${{github.workspace}}/consumer-install/lib/pkgconfig/graaf.pc" ]; then
            echo "::error::graaf.pc should not be installed when Graaf is consumed via FetchContent"
            exit 1
          fi