build.yml

name: build

on:
  push:
    branches: [ unstable, '[0-9]+.[0-9]+.x' ]
  pull_request:
    branches: [ unstable, '[0-9]+.[0-9]+.x' ]
  workflow_call:
  workflow_dispatch:

env:
  CMAKE_C_COMPILER_LAUNCHER: ccache
  CMAKE_CXX_COMPILER_LAUNCHER: ccache
  CCACHE_COMPILERCHECK: content
  CCACHE_BASEDIR: ${{ github.workspace }}
  CCACHE_DIR: ${{ github.workspace }}/.ccache
  CCACHE_MAXSIZE: 500M
  CCACHE_SLOPPINESS: pch_defines,time_macros,include_file_mtime,include_file_ctime
  CCACHE_COMPRESS: "1"
  CCACHE_COMPRESSLEVEL: "1"

jobs:
  build:

    strategy:
      fail-fast: false
      matrix:
        include:
          - {os: ubuntu-24.04, cc: gcc, cxx: g++, doc: OFF, cov: ON}
          - {os: ubuntu-24.04, cc: clang, cxx: clang++, doc: ON, cov: OFF}
          - {os: macos-14, cc: gcc-14, cxx: g++-14, doc: OFF, cov: OFF}
          - {os: macos-14, cc: clang, cxx: clang++, doc: OFF, cov: OFF}

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

    steps:
    - uses: actions/checkout@v4

    - uses: actions/cache/restore@v4
      with:
        path: ${{ env.CCACHE_DIR }}
        key: ccache-${{ matrix.os }}-${{ matrix.cc }}-${{ github.run_id }}
        restore-keys:
          ccache-${{ matrix.os }}-${{ matrix.cc }}-

    - name: Install ubuntu dependencies
      if: ${{ contains(matrix.os, 'ubuntu') }}
      run: >
        sudo apt-get update &&
        sudo apt-get install lsb-release wget software-properties-common &&
        sudo apt-get install
        ccache
        clang
        g++
        gfortran
        hdf5-tools
        libblas-dev
        libclang-dev
        libc++-dev
        libc++abi-dev
        libomp-dev
        libfftw3-dev
        libgfortran5
        libgmp-dev
        libhdf5-dev
        liblapack-dev
        libopenmpi-dev
        openmpi-bin
        openmpi-common
        openmpi-doc
        python3-clang
        python3-dev
        python3-mako
        python3-mpi4py
        python3-numpy
        python3-pip
        python3-scipy
        python3-sphinx
        python3-nbsphinx

    - name: Set up virtualenv
      run: |
        mkdir $HOME/.venv
        python3 -m venv --system-site-packages $HOME/.venv/my_python
        source $HOME/.venv/my_python/bin/activate
        echo "VIRTUAL_ENV=$VIRTUAL_ENV" >> $GITHUB_ENV
        echo "PATH=$PATH" >> $GITHUB_ENV

    - name: Install homebrew dependencies
      if: ${{ contains(matrix.os, 'macos') }}
      run: |
        brew update
        brew install ccache gcc llvm hdf5 open-mpi openblas
        pip install mako numpy scipy mpi4py
        pip install -r requirements.txt
        echo "PATH=$(brew --prefix llvm)/bin:$(brew --prefix gcc)/bin:$PATH" >> $GITHUB_ENV

    - name: Build doxygen
      if: matrix.doc == 'ON'
      env:
        CC: ${{ matrix.cc }}
        CXX: ${{ matrix.cxx }}
      run: |
        cd $HOME
        git clone https://github.com/doxygen/doxygen.git
        cd doxygen
        git checkout Release_1_12_0
        mkdir build
        cd build
        cmake .. -Duse_libclang=ON -Duse_libc++=OFF
        make -j 2 VERBOSE=1
        cp bin/doxygen /usr/local/bin/doxygen

    - name: Add clang CXXFLAGS
      if: ${{ contains(matrix.cxx, 'clang') }}
      run: |
        echo "CXXFLAGS=-stdlib=libc++" >> $GITHUB_ENV

    - name: Add clang LDFLAGS for macos to link against brew's libc++
      if: ${{ contains(matrix.os, 'macos') && contains(matrix.cxx, 'clang') }}
      run: |
        echo 'LDFLAGS="-L$(brew --prefix llvm)/lib/c++ -L$(brew --prefix llvm)/lib -lunwind"' >> $GITHUB_ENV

    - name: Set up test coverage
      if: matrix.cov == 'ON'
      run: |
        pip install gcovr
        echo "CXXFLAGS=--coverage" >> $GITHUB_ENV

    - name: Prepare source files for doxygen
      if: matrix.doc == 'ON'
      working-directory: ./c++/nda
      run: |
        sed -e '/#include .*impl.*.hpp/{r _impl_basic_array_view_common.hpp' -e 'd' -e '}' basic_array.hpp > tmp_basic_array.hpp
        sed -e '/#include .*impl.*.hpp/{r _impl_basic_array_view_common.hpp' -e 'd' -e '}' basic_array_view.hpp > tmp_basic_array_view.hpp
        mv tmp_basic_array.hpp basic_array.hpp
        mv tmp_basic_array_view.hpp basic_array_view.hpp

    - name: Build nda
      env:
        CC: ${{ matrix.cc }}
        CXX: ${{ matrix.cxx }}
      run: |
        mkdir build && cd build && cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/install -DPythonSupport=ON -DBuild_Documentation=${{ matrix.doc }} -DCMAKE_BUILD_TYPE=${{ matrix.cov == 'ON' && 'Debug' || 'Release' }}
        make -j2 || make -j1 VERBOSE=1

    - name: Test nda
      env:
        OPENBLAS_NUM_THREADS: "1"
      run: |
        cd build
        ctest -j2 --output-on-failure

    - name: Generate test coverage HTML output
      if: matrix.cov == 'ON'
      run: |
        cd build
        mkdir coverage
        gcovr --gcov-executable "gcov" --root ../c++ --html-details -o coverage/coverage.html .

    - name: ccache statistics
      if: always()
      run: ccache -sv

    - uses: actions/cache/save@v4
      if: always()
      with:
        path: ${{ env.CCACHE_DIR }}
        key: ccache-${{ matrix.os }}-${{ matrix.cc }}-${{ github.run_id }}

    - name: Deploy documentation
      if: matrix.doc == 'ON' && github.ref == 'refs/heads/unstable'
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        folder: build/doc/html
        branch: github.io
        target-folder: docs/unstable

    - name: Deploy test coverage
      if: matrix.cov == 'ON' && github.ref == 'refs/heads/unstable'
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        folder: build/coverage
        branch: github.io
        target-folder: docs/coverage