build.yaml

name: Build PR(s) and master branch.
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
    types: [opened, reopened, synchronize]
jobs:
  build-windows:
    name: Build sources on amd64 for ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [windows-latest, windows-2022]
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: true

      - name: Set up with Developer Command Prompt for Microsoft Visual C++
        uses: ilammy/msvc-dev-cmd@v1
        with:
          toolset: 14.29 # For using VS2019 C++

      - name: Build on ${{ matrix.os }} with vs-2019
        run: |
          .\scripts\win_build.bat

      - name: Run unit tests.
        run: |
          ctest --rerun-failed --output-on-failure -C Debug --test-dir .\tests\

  build-centos:
    name: CentOS 7 build to confirm no issues once used downstream
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Check out the repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          submodules: recursive

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1

      - name: Build sources on CentOS 7
        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
        with:
          context: .
          file: ./dockerfiles/Dockerfile.centos7
          push: false
          load: false
          provenance: false

  build-debian:
    name: Debian Bookworm build to confirm no issues once used downstream
    runs-on: ubuntu-latest
    container: debian:bookworm
    steps:
      - name: Set up base image dependencies
        run: |
          apt-get update
          apt-get install -y build-essential wget make gcc g++ git libcurl4-openssl-dev

      - name: Check out the repository
        uses: actions/checkout@v7
        with:
          submodules: recursive

      - name: Install CMake 3.20.0
        run: |
          CMAKE_VERSION=3.20.0
          wget https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.sh
          chmod +x cmake-${CMAKE_VERSION}-linux-x86_64.sh
          ./cmake-${CMAKE_VERSION}-linux-x86_64.sh --skip-license --prefix=/usr/local

          # Ensure the new CMake is found first
          echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc
          export PATH="/usr/local/bin:$PATH"

          # Confirm CMake installation
          /usr/local/bin/cmake --version

      - name: Run compilation
        run: |
          cmake -S . -B build -DCTR_TESTS=On -DCTR_DEV=On
          cmake --build build -j "$(getconf _NPROCESSORS_ONLN)"
          ctest --test-dir build --output-on-failure
        shell: bash

  build-unix-arm64:
    name: Build sources on arm64 for ${{ matrix.os }} - ${{ matrix.compiler }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        compiler: [ gcc, clang ]
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: true

      - name: Build on ${{ matrix.os }} with ${{ matrix.compiler }}
        uses: uraimo/run-on-arch-action@v3.2.1
        with:
          arch: aarch64
          distro: ubuntu_latest
          run: |
            apt-get update && \
            apt-get install -y --no-install-recommends \
            build-essential \
            cmake \
            file \
            make
            export CC=${{ env.compiler }}
            cmake -DCTR_TESTS=On .
            make all
            CTEST_OUTPUT_ON_FAILURE=1 make test
        env:
          CC: ${{ matrix.compiler }}

  build-unix-amd64:
    name: Build sources on amd64 for ${{ matrix.os }} - ${{ matrix.compiler }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest]
        compiler: [ gcc, clang ]
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: true

      - name: Build on ${{ matrix.os }} with ${{ matrix.compiler }}
        run: |
          echo "CC = $CC, CXX = $CXX"
          cmake -DCTR_TESTS=On .
          make all
          CTEST_OUTPUT_ON_FAILURE=1 make test
        shell: bash
        env:
          CC: ${{ matrix.compiler }}

  build-analysis-tests:
    name: Build with various code analysis tools
    strategy:
      fail-fast: false
      matrix:
        preset:
          - clang-sanitize-address
          - clang-sanitize-memory
          - clang-sanitize-undefined
          - clang-sanitize-dataflow
          - clang-sanitize-safe-stack
          - valgrind
    permissions:
      contents: read
    runs-on: ubuntu-latest
    steps:
      - name: Check out the repository
        uses: actions/checkout@v7
        with:
          submodules: true

      - name: Install Dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y \
            clang \
            valgrind \
            wget \
            make \
            gcc \
            g++ \
            git \
            libcurl4-openssl-dev

      - name: Install CMake 3.20.0 or higher
        run: |
          CMAKE_VERSION=3.20.0
          wget https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.sh
          chmod +x cmake-${CMAKE_VERSION}-linux-x86_64.sh
          sudo ./cmake-${CMAKE_VERSION}-linux-x86_64.sh --skip-license --prefix=/usr/local
          sudo ln -sf /usr/local/bin/cmake /usr/bin/cmake
          /usr/local/bin/cmake --version

      - name: Initialize Submodules
        run: git submodule update --init --recursive

      - name: Configure and Build
        run: |
          /usr/local/bin/cmake -DCTR_TESTS=On -DCTR_DEV=On .
          make all

  # this job provides the single required status for PRs to be merged into main.
  # instead of updating the protected branch status in github, developers can update the needs section below
  # to require additional status checks to protect main.
  # the job uses the alls-green action to get around the github issue that treats a "skipped" required status check
  # as passed. github will skip a job if an upstream needed job fails, which would defeat the purpose of this required
  # status check.
  test-required-checks-complete:
    # note: this step always has to run in order to check if the dependent jobs passed. by default github skips running a job
    # if the needed jobs upstream failed.
    if: always()
    needs:
      - build-windows
      - build-centos
      - build-debian
      - build-unix-arm64
      - build-unix-amd64
      - build-analysis-tests
    name: Required checks complete
    runs-on: ubuntu-latest
    permissions: {}
    steps:
    - name: Decide whether the needed jobs succeeded or failed
      uses: re-actors/alls-green@release/v1
      with:
        jobs: ${{ toJSON(needs) }}