Add VCPKG usage to GitHub Actions (#243)

2024-08-23 10:05:56 -07:00 · 2024-08-23 10:05:56 -07:00 · 33a957ed44
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -30,7 +30,7 @@ jobs:

      matrix:
        os: [windows-2019, windows-2022]
-        build_type: [x64-Debug, x64-Release, x64-Debug-Clang, x64-Release-Clang]
+        build_type: [x64-Debug, x64-Release]
        arch: [amd64]
        include:
          - os: windows-2019
@ -39,18 +39,18 @@ jobs:
          - os: windows-2019
            build_type: x86-Release
            arch: amd64_x86
-          - os: windows-2019
-            build_type: x86-Debug-Clang
-            arch: amd64_x86
-          - os: windows-2019
-            build_type: x86-Release-Clang
-            arch: amd64_x86
          - os: windows-2022
            build_type: x86-Debug
            arch: amd64_x86
          - os: windows-2022
            build_type: x86-Release
            arch: amd64_x86
+          - os: windows-2022
+            build_type: x64-Debug-Clang
+            arch: amd64
+          - os: windows-2022
+            build_type: x64-Release-Clang
+            arch: amd64
          - os: windows-2022
            build_type: x86-Debug-Clang
            arch: amd64_x86
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -31,7 +31,7 @@ jobs:

      matrix:
        os: [windows-2019, windows-2022]
-        build_type: [x64-Debug, x64-Release, x64-Debug-Clang, x64-Release-Clang]
+        build_type: [x64-Debug, x64-Release]
        arch: [amd64]
        include:
          - os: windows-2019
@ -40,18 +40,18 @@ jobs:
          - os: windows-2019
            build_type: x86-Release
            arch: amd64_x86
-          - os: windows-2019
-            build_type: x86-Debug-Clang
-            arch: amd64_x86
-          - os: windows-2019
-            build_type: x86-Release-Clang
-            arch: amd64_x86
          - os: windows-2022
            build_type: x86-Debug
            arch: amd64_x86
          - os: windows-2022
            build_type: x86-Release
            arch: amd64_x86
+          - os: windows-2022
+            build_type: x64-Debug-Clang
+            arch: amd64
+          - os: windows-2022
+            build_type: x64-Release-Clang
+            arch: amd64
          - os: windows-2022
            build_type: x86-Debug-Clang
            arch: amd64_x86
--- a/.github/workflows/vcpkg.yml
+++ b/.github/workflows/vcpkg.yml
@ -0,0 +1,93 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+#
+# http://go.microsoft.com/fwlink/?LinkID=615561
+
+name: 'CMake (Windows using VCPKG)'
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+    paths-ignore:
+      - '*.md'
+      - LICENSE
+      - build/*
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        os: [windows-2019, windows-2022]
+        build_type: [x64-Debug-VCPKG]
+        arch: [amd64]
+        include:
+          - os: windows-2022
+            build_type: x64-Debug-Clang-VCPKG
+            arch: amd64
+          - os: windows-2022
+            build_type: x86-Debug-VCPKG
+            arch: amd64_x86
+          - os: windows-2022
+            build_type: arm64-Debug-VCPKG
+            arch: amd64_arm64
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: 'Install Ninja'
+      run: choco install ninja
+
+    - uses: ilammy/msvc-dev-cmd@v1
+      with:
+        arch: ${{ matrix.arch }}
+
+    - name: 'Set triplet'
+      shell: pwsh
+      run: |
+        echo "VCPKG_INSTALLED_DIR=${{ github.workspace }}/build/vcpkg_installed" >> $env:GITHUB_ENV
+        if ("${{ matrix.arch }}" -eq "amd64")
+        {
+            echo "VCPKG_DEFAULT_TRIPLET=x64-windows" >> $env:GITHUB_ENV
+        }
+        elseif ("${{ matrix.arch }}" -eq "amd64_x86")
+        {
+            echo "VCPKG_DEFAULT_TRIPLET=x86-windows" >> $env:GITHUB_ENV
+        }
+        elseif ("${{ matrix.arch }}" -eq "amd64_arm64")
+        {
+            if ("${{ matrix.build_type }}" -match "^arm64ec")
+            {
+                echo "VCPKG_DEFAULT_TRIPLET=arm64ec-windows" >> $env:GITHUB_ENV
+            }
+            else
+            {
+                echo "VCPKG_DEFAULT_TRIPLET=arm64-windows" >> $env:GITHUB_ENV
+            }
+        }
+        else
+        {
+            echo "::error Unknown architecture/build-type triplet mapping"
+        }
+
+    - uses: lukka/run-vcpkg@v11
+      with:
+        runVcpkgInstall: true
+        vcpkgJsonGlob: '**/build/vcpkg.json'
+        vcpkgGitCommitId: '7516a02de04e8f8ff4e4beb8f5bac0565f9bf9da'
+
+    - name: 'Configure CMake'
+      working-directory: ${{ github.workspace }}
+      run: >
+        cmake --preset=${{ matrix.build_type }} -DBUILD_TESTING=OFF -DBUILD_XAUDIO_WIN10=OFF -DBUILD_XAUDIO_REDIST=ON
+        -DCMAKE_TOOLCHAIN_FILE="${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake" -DVCPKG_MANIFEST_DIR="${{ github.workspace }}/build"
+        -DVCPKG_TARGET_TRIPLET="${env:VCPKG_DEFAULT_TRIPLET}"
+
+    - name: 'Build'
+      working-directory: ${{ github.workspace }}
+      run: cmake --build out\build\${{ matrix.build_type }}
--- a/.gitignore
+++ b/.gitignore
@ -27,3 +27,4 @@ Bin
 /wiki
 /out
 /CMakeUserPresets.json
+/build/vcpkg_installed
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -191,7 +191,11 @@ set(SHADER_SOURCES ${SHADER_SOURCES}
    Src/Shaders/Utilities.fxh)

 if(MINGW)
-   set(BUILD_XAUDIO_WIN10 OFF)
+  set(BUILD_XAUDIO_WIN10 OFF)
+endif()
+
+if(${DIRECTX_ARCH} MATCHES "^arm")
+  set(BUILD_XAUDIO_REDIST OFF)
 endif()

 if(WINDOWS_STORE
@ -252,7 +256,8 @@ if(NOT USE_PREBUILT_SHADERS)
        message(STATUS "Using VCPKG for DirectXShaderCompiler (${VCPKG_HOST_TRIPLET}).")
        find_program(DIRECTX_DXC_TOOL DXC.EXE
          REQUIRED NO_SYSTEM_ENVIRONMENT_PATH NO_CMAKE_SYSTEM_PATH NO_DEFAULT_PATH
-          HINTS ${DIRECTX_DXC_PATH})
+          HINTS ${DIRECTX_DXC_PATH}
+                "${CMAKE_CURRENT_LIST_DIR}/build/vcpkg_installed/${VCPKG_HOST_TRIPLET}/tools/directx-dxc")
    endif()
    add_custom_command(
        OUTPUT "${COMPILED_SHADERS}/SpriteEffect_SpriteVertexShader.inc"
--- a/CMakePresets.json
+++ b/CMakePresets.json
@ -280,16 +280,16 @@
    { "name": "x64-Debug-Durango"    , "description": "MSVC for x64 (Debug) for legacy Xbox One XDK", "inherits": [ "base", "x64", "Debug", "MSVC", "Durango" ] },
    { "name": "x64-Release-Durango"  , "description": "MSVC for x64 (Release) for legacy Xbox One XDK", "inherits": [ "base", "x64", "Release", "MSVC", "Durango" ] },

-    { "name": "x64-Debug-VCPKG"           , "description": "MSVC for x64 (Debug)", "inherits": [ "base", "x64", "Debug", "MSVC", "VCPKG", "XAudio2Redist", "X64_X64" ] },
-    { "name": "x64-Release-VCPKG"         , "description": "MSVC for x64 (Release)", "inherits": [ "base", "x64", "Release", "MSVC", "VCPKG", "XAudio2Redist", "X64_X64" ] },
-    { "name": "x86-Debug-VCPKG"           , "description": "MSVC for x86 (Debug)", "inherits": [ "base", "x86", "Debug", "MSVC", "VCPKG", "XAudio2Redist", "X64_X86" ] },
-    { "name": "x86-Release-VCPKG"         , "description": "MSVC for x86 (Release)", "inherits": [ "base", "x86", "Release", "MSVC", "VCPKG", "XAudio2Redist", "X64_X86" ] },
-    { "name": "arm64-Debug-VCPKG"         , "description": "MSVC for ARM64 (Debug)", "inherits": [ "base", "ARM64", "Debug", "MSVC", "VCPKG", "X64_ARM64" ] },
-    { "name": "arm64-Release-VCPKG"       , "description": "MSVC for ARM64 (Release)", "inherits": [ "base", "ARM64", "Release", "MSVC", "VCPKG", "X64_ARM64" ] },
-    { "name": "arm64-Native-Debug-VCPKG"  , "description": "MSVC for ARM64 Native (Debug)", "inherits": [ "base", "ARM64", "Debug", "MSVC", "VCPKG", "ARM64_ARM64" ] },
-    { "name": "arm64-Native-Release-VCPKG", "description": "MSVC for ARM64 Native (Release)", "inherits": [ "base", "ARM64", "Release", "MSVC", "VCPKG", "ARM64_ARM64" ] },
-    { "name": "arm64ec-Debug-VCPKG"       , "description": "MSVC for ARM64EC (Debug)", "inherits": [ "base", "ARM64EC", "Debug", "MSVC", "VCPKG", "X64_ARM64EC" ], "environment": { "CXXFLAGS": "/arm64EC" } },
-    { "name": "arm64ec-Release-VCPKG"     , "description": "MSVC for ARM64EC (Release)", "inherits": [ "base", "ARM64EC", "Release", "MSVC", "VCPKG", "X64_ARM64EC" ], "environment": { "CXXFLAGS": "/arm64EC" } },
+    { "name": "x64-Debug-VCPKG"           , "description": "MSVC for x64 (Debug) using VCPKG", "inherits": [ "base", "x64", "Debug", "MSVC", "VCPKG", "XAudio2Redist", "X64_X64" ] },
+    { "name": "x64-Release-VCPKG"         , "description": "MSVC for x64 (Release) using VCPKG", "inherits": [ "base", "x64", "Release", "MSVC", "VCPKG", "XAudio2Redist", "X64_X64" ] },
+    { "name": "x86-Debug-VCPKG"           , "description": "MSVC for x86 (Debug) using VCPKG", "inherits": [ "base", "x86", "Debug", "MSVC", "VCPKG", "XAudio2Redist", "X64_X86" ] },
+    { "name": "x86-Release-VCPKG"         , "description": "MSVC for x86 (Release) using VCPKG", "inherits": [ "base", "x86", "Release", "MSVC", "VCPKG", "XAudio2Redist", "X64_X86" ] },
+    { "name": "arm64-Debug-VCPKG"         , "description": "MSVC for ARM64 (Debug) using VCPKG", "inherits": [ "base", "ARM64", "Debug", "MSVC", "VCPKG", "X64_ARM64" ] },
+    { "name": "arm64-Release-VCPKG"       , "description": "MSVC for ARM64 (Release) using VCPKG", "inherits": [ "base", "ARM64", "Release", "MSVC", "VCPKG", "X64_ARM64" ] },
+    { "name": "arm64-Native-Debug-VCPKG"  , "description": "MSVC for ARM64 Native (Debug) using VCPKG", "inherits": [ "base", "ARM64", "Debug", "MSVC", "VCPKG", "ARM64_ARM64" ] },
+    { "name": "arm64-Native-Release-VCPKG", "description": "MSVC for ARM64 Native (Release) using VCPKG", "inherits": [ "base", "ARM64", "Release", "MSVC", "VCPKG", "ARM64_ARM64" ] },
+    { "name": "arm64ec-Debug-VCPKG"       , "description": "MSVC for ARM64EC (Debug) using VCPKG", "inherits": [ "base", "ARM64EC", "Debug", "MSVC", "VCPKG", "X64_ARM64EC" ], "environment": { "CXXFLAGS": "/arm64EC" } },
+    { "name": "arm64ec-Release-VCPKG"     , "description": "MSVC for ARM64EC (Release) using VCPKG", "inherits": [ "base", "ARM64EC", "Release", "MSVC", "VCPKG", "X64_ARM64EC" ], "environment": { "CXXFLAGS": "/arm64EC" } },

    { "name": "x64-Debug-Clang"    , "description": "Clang/LLVM for x64 (Debug) for Windows 10", "inherits": [ "base", "x64", "Debug", "Clang" ] },
    { "name": "x64-Release-Clang"  , "description": "Clang/LLVM for x64 (Release) for Windows 10", "inherits": [ "base", "x64", "Release", "Clang" ] },
@ -298,6 +298,11 @@
    { "name": "arm64-Debug-Clang"  , "description": "Clang/LLVM for AArch64 (Debug) for Windows 10", "inherits": [ "base", "ARM64", "Debug", "Clang" ], "environment": { "CXXFLAGS": "--target=arm64-pc-windows-msvc" } },
    { "name": "arm64-Release-Clang", "description": "Clang/LLVM for AArch64 (Release) for Windows 10", "inherits": [ "base", "ARM64", "Release", "Clang" ], "environment": { "CXXFLAGS": "--target=arm64-pc-windows-msvc" } },

+    { "name": "x64-Debug-Clang-VCPKG"   , "description": "Clang/LLVM for x64 (Debug) using VCPKG", "inherits": [ "base", "x64", "Debug", "Clang", "VCPKG", "XAudio2Redist", "X64_X64" ] },
+    { "name": "x64-Release-Clang-VCPKG" , "description": "Clang/LLVM for x64 (Release) using VCPKG", "inherits": [ "base", "x64", "Release", "Clang", "VCPKG", "XAudio2Redist", "X64_X64" ] },
+    { "name": "x86-Debug-Clang-VCPKG"   , "description": "Clang/LLVM for x86 (Debug) using VCPKG", "inherits": [ "base", "x86", "Debug", "Clang", "VCPKG", "XAudio2Redist", "X64_X86" ], "environment": { "CXXFLAGS": "-m32" } },
+    { "name": "x86-Release-Clang-VCPKG" , "description": "Clang/LLVM for x86 (Debug) using VCPKG", "inherits": [ "base", "x86", "Release", "Clang", "VCPKG", "XAudio2Redist", "X64_X86" ], "environment": { "CXXFLAGS": "-m32" } },
+
    { "name": "x64-Debug-UWP-Clang"    , "description": "Clang/LLVM for x64 (Debug) for UWP", "inherits": [ "base", "x64", "Debug", "Clang", "UWP" ] },
    { "name": "x64-Release-UWP-Clang"  , "description": "Clang/LLVM for x64 (Release) for UWP", "inherits": [ "base", "x64", "Release", "Clang", "UWP" ] },
    { "name": "x86-Debug-UWP-Clang"    , "description": "Clang/LLVM for x86 (Debug) for UWP", "inherits": [ "base", "x86", "Debug", "Clang", "UWP" ], "environment": { "CXXFLAGS": "-m32" } },
--- a/build/CompilerAndLinker.cmake
+++ b/build/CompilerAndLinker.cmake
@ -136,7 +136,8 @@ elseif(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
      list(APPEND COMPILER_SWITCHES /Zc:lambda)
    endif()

-    if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.29)
+    if((CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.29)
+       AND (NOT VCPKG_TOOLCHAIN))
      list(APPEND COMPILER_SWITCHES /external:W4)
    endif()

--- a/build/vcpkg.json
+++ b/build/vcpkg.json
@ -0,0 +1,15 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg-tool/main/docs/vcpkg.schema.json",
+    "dependencies": [
+      "directxmath",
+      {
+        "name": "directx-dxc",
+        "host": true
+      },
+      "directx-headers",
+      {
+        "name": "xaudio2redist",
+        "platform": "windows & !arm"
+      }
+    ]
+  }