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:
    permissions:
      contents: read
      pull-requests: write

    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-latest, windows-latest]
        build_type: [Release]
        c_compiler: [gcc, clang, cl]
        include:
          - os: windows-latest
            c_compiler: cl
            cpp_compiler: cl
          - os: ubuntu-latest
            c_compiler: gcc
            cpp_compiler: g++
          - os: ubuntu-latest
            c_compiler: clang
            cpp_compiler: clang++
        exclude:
          - os: windows-latest
            c_compiler: gcc
          - os: windows-latest
            c_compiler: clang
          - os: ubuntu-latest
            c_compiler: cl

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        submodules: recursive
        fetch-depth: 0

    - 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"

    - name: Cache APT Packages (Linux)
      if: runner.os == 'Linux'
      uses: awalsh128/cache-apt-pkgs-action@v1.5.3
      with:
        # Space delimited list of packages to install. Version can be specified optionally using APT command syntax of <name>=<version> (e.g. xdot=1.2-2).
        packages: cmake make libx11-dev libxext-dev gcc libxi-dev vulkan-tools libvulkan-dev libvulkan1 glslang-tools spirv-tools

    - name: Get DirectX shaders compiler (Linux)
      if: runner.os == 'Linux'
      run: |
        curl -LO https://github.com/microsoft/DirectXShaderCompiler/releases/download/v1.9.2602/linux_dxc_2026_02_20.x86_64.tar.gz
        tar -xf linux_dxc_*.tar.gz
        sudo cp bin/dxc /usr/local/bin/
        sudo cp lib/libdxcompiler.so* /usr/local/lib/
        sudo cp lib/libdxil.so /usr/local/lib/
        sudo ldconfig

    - name: Cache Vulkan SDK (Windows)
      if: runner.os == 'Windows'
      id: cache-vulkan
      uses: actions/cache@v4
      with:
        path: C:/VulkanSDK
        key: ${{ runner.os }}-vulkan

    - name: Install Vulkan SDK (Windows)
      if: runner.os == 'Windows' && steps.cache-vulkan.outputs.cache-hit != 'true'
      id: vulkan
      run: |
          curl -L https://sdk.lunarg.com/sdk/download/latest/windows/vulkan-sdk.exe --output VulkanSDK.exe
          ./VulkanSDK.exe --accept-licenses --default-answer --confirm-command install
      shell: pwsh

    - name: Add Vulkan SDK to PATH (Windows)
      if: runner.os == 'Windows'
      run: |
        $vulkan_sdk_path = "C:\\VulkanSDK"
        $vulkan_version = Get-ChildItem -Path $vulkan_sdk_path -Directory | Sort-Object Name | Select-Object -Last 1
        $vulkan_version_path = "$vulkan_sdk_path\\$($vulkan_version.Name)"

        Write-Output "Vulkan SDK Version Path: $vulkan_version_path"
        Write-Output "Vulkan Include Directory Path: $vulkan_version_path\\include"
        Write-Output "Vulkan Library Path: $vulkan_version_path\\lib\\vulkan-1.lib"
        Write-Output "Vulkan Bin Path: $vulkan_version_path\\Bin"

        Add-Content -Path $env:GITHUB_ENV -Value "VULKAN_SDK=$vulkan_version_path"
        Add-Content -Path $env:GITHUB_ENV -Value "VULKAN_INCLUDE_DIR=$vulkan_version_path\\include"
        Add-Content -Path $env:GITHUB_ENV -Value "VULKAN_LIBRARY=$vulkan_version_path\\lib\\vulkan-1.lib"

        Add-Content -Path $env:GITHUB_ENV -Value "PATH=$vulkan_version_path\\;$vulkan_version_path\\lib;$vulkan_version_path\\bin;$env:PATH"
      shell: pwsh

    - name: Verify GITHUB_ENV file content
      run: |
        cat $env:GITHUB_ENV
      shell: pwsh

    - name: Configure CMake
      run:
        cmake -B ${{ steps.strings.outputs.build-output-dir }}
        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
        -S ${{ github.workspace }}

    - name: Build
      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 }}