cmake.yml

name: ⚙️ CMake

on:
  push:
    branches: [ development ]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ development ]
  merge_group:
    branches: [ development ]

concurrency:
  group: ${{ github.ref }}-${{ github.head_ref }}-cmake-linux
  cancel-in-progress: true

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

permissions:
  contents: read

jobs:
  check_changes:
    uses: ./.github/workflows/check_changes.yml
    with:
      workflow_file: '.github/workflows/cmake.yml'

  build:
    runs-on: ubuntu-latest
    needs: check_changes
    if: needs.check_changes.outputs.has_non_docs_changes == 'true'
    env:
      CCACHE_COMPRESS: '1'
      CCACHE_COMPRESSLEVEL: '10'
      CCACHE_MAXSIZE: 450M

    steps:
    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v4.2.2
      with:
        submodules: true
        fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of sonarcloud analysis

    - name: Install dependencies
      run: sudo apt-get update && sudo apt-get install -y cmake ccache gcc-13 g++-13 python3-dev python3-venv python3-numpy python3-matplotlib python3-pip libopenmpi-dev libhdf5-mpi-dev

    - name: Create Build Environment
      # Some projects don't allow in-source building, so create a separate build directory
      # We'll use this as our working directory for all subsequent commands
      run: cmake -E make_directory ${{runner.workspace}}/build

    - name: Install ccache
      run: .github/workflows/dependencies/dependencies_ccache.sh

    - name: Set Up Cache
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: ~/.cache/ccache
        key: ccache-${{ github.workflow }}-${{ github.job }}-git-${{ github.sha }}
        restore-keys: |
             ccache-${{ github.workflow }}-${{ github.job }}-git-

    - name: Install Canary
      run: |
        python3 -m venv ${{runner.temp}}/canary-venv
        ${{runner.temp}}/canary-venv/bin/python -m pip install --upgrade pip
        ${{runner.temp}}/canary-venv/bin/pip install canary-wm==25.10.7
        echo "${{runner.temp}}/canary-venv/bin" >> "$GITHUB_PATH"

    - name: Initialize ccache
      run: |
        ccache --version
        ccache -z

    - name: Configure CMake
      # Use a bash shell so we can use the same syntax for environment variable
      # access regardless of the host operating system
      shell: bash
      working-directory: ${{runner.workspace}}/build
      # Note the current convention is to use the -S and -B options here to specify source 
      # and build directories, but this is only available with CMake 3.13 and higher.  
      # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_C_COMPILER=gcc-13 -DCMAKE_CXX_COMPILER=g++-13 -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DENABLE_ASAN=ON

    - name: Build
      working-directory: ${{runner.workspace}}/build
      shell: bash
      # Execute the build.  You can specify a specific target with "--target <NAME>"
      run: cmake --build . --config $BUILD_TYPE --parallel 4

    - name: Create test output directory
      run: cmake -E make_directory $GITHUB_WORKSPACE/tests

    - name: Test
      working-directory: ${{runner.workspace}}/build
      shell: bash
      run: ASAN_OPTIONS=abort_on_error=1:fast_unwind_on_malloc=1:detect_leaks=0 UBSAN_OPTIONS=print_stacktrace=0 LSAN_OPTIONS=suppressions=$GITHUB_WORKSPACE/inputs/leak_suppress.txt canary run --output-on-failure --workers=2 -k 'not HydroWaveConvergence' .

    - name: ccache stats
      if: always()
      run: |
        ccache -s || true
        du -hs ~/.cache/ccache || true

    - name: Upload test output
      if: always() && !env.ACT
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: test-results
        path: ${{github.workspace}}/tests