cmake-multi-platform.yml

# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
name: CMake on multiple platforms

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

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

    strategy:
      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
      fail-fast: false

      # Set up a matrix to run the following 3 configurations:
      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
      #
      # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
      matrix:
        os: [ubuntu-24.04, windows-latest]
        build_type: [Debug, Release, RelWithDebInfo]
        #c_compiler: [gcc, clang, cl] # GCC is disabled until they fix their parser.
        c_compiler: [clang, cl]
        include:
          - os: windows-latest
            c_compiler: cl
            cpp_compiler: cl
          #- os: ubuntu-24.04
          #  c_compiler: gcc
          #  cpp_compiler: g++
          - os: ubuntu-24.04
            c_compiler: clang
            cpp_compiler: clang++
        exclude:
          #- os: windows-latest
          #  c_compiler: gcc
          - os: windows-latest
            c_compiler: clang
          - os: ubuntu-24.04
            c_compiler: cl

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive # Check out submodules

    - name: Set reusable strings
      # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
      id: strings
      shell: bash
      run: |
        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
        echo "scripts-dir=${{ github.workspace }}/scripts" >> "$GITHUB_OUTPUT"
        echo "vcpkg-dir=${{ github.workspace }}/vcpkg" >> "$GITHUB_OUTPUT"

    - name: Clean vcpkg directory if exists (Linux)
      if: runner.os == 'Linux'
      shell: bash
      run: |
        echo "Cleaning vcpkg directory at ${{ steps.strings.outputs.vcpkg-dir }}..."
        rm -rf "${{ steps.strings.outputs.vcpkg-dir }}"

    - name: Clean vcpkg directory if exists (Windows)
      if: runner.os == 'Windows'
      shell: pwsh
      run: |
        $vcpkgDir = "${{ steps.strings.outputs.vcpkg-dir }}"
        Write-Host "Cleaning vcpkg directory at $vcpkgDir..."
        if (Test-Path -Path $vcpkgDir) {
            Remove-Item -Recurse -Force -Path $vcpkgDir
        }

    - name: Cache vcpkg
      uses: actions/cache@v4
      with:
        path: ${{ steps.strings.outputs.vcpkg-dir }}
        key: ${{ runner.os }}-${{ matrix.build_type }}-vcpkg-${{ hashFiles('**/vcpkg.json') }}
        restore-keys: |
          ${{ runner.os }}-${{ matrix.build_type }}-vcpkg-cache

    # Step for Linux
    - name: Set up dependencies on Linux
      if: runner.os == 'Linux'
      shell: bash
      run: |
        scripts_dir="${{ steps.strings.outputs.scripts-dir }}"
        deb_setup_script="${scripts_dir}/deb_setup.sh"
        vcpkg_script="${scripts_dir}/deb_vcpkg.sh"
        vcpkg_dir="${{ steps.strings.outputs.vcpkg-dir }}"
        
        # Update the system packages
        sudo apt-get update
        sudo apt-get upgrade -y
        
        # Make the scripts executable
        chmod +x "$deb_setup_script"
        chmod +x "$vcpkg_script"
        
        # Run deb_setup.sh to set-up prerequisite packages and compiler support
        "$deb_setup_script"
        
        # Run vcpkg.sh with the appropriate triplet
        "$vcpkg_script" https "$vcpkg_dir"
    
    # Step for Windows
    - name: Set up dependencies on Windows
      if: runner.os == 'Windows'
      shell: pwsh
      run: |
        powershell -ExecutionPolicy Bypass -File "${{ steps.strings.outputs.scripts-dir }}\\vcpkg.ps1" `
          https "${{ steps.strings.outputs.vcpkg-dir }}"

    - 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 ${{ steps.strings.outputs.build-output-dir }}
        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
        -S ${{ github.workspace }}

    - name: Build
      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}

#    - name: Test
#     working-directory: ${{ steps.strings.outputs.build-output-dir }}
      # Execute tests defined by the CMake configuration. Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
#      run: ctest --build-config ${{ matrix.build_type }}