try new windows build

Author: SteveBronder

.github/workflows/build-and-release-windows.yml

@@ -6,49 +6,80 @@ on:
       - main
 
 jobs:
+  env:
+    # Indicates the location of the vcpkg as a Git submodule of the project repository.
+    # Not using "VCPKG_ROOT" because a variable with the same name is defined in the VS's
+    # Developer Command Prompt environment in VS 2022 17.6, which would override this one
+    # if it had the same name.
+    _VCPKG_: ${{ github.workspace }}/vcpkg
+    # Tells vcpkg where binary packages are stored.
+    VCPKG_DEFAULT_BINARY_CACHE: ${{ github.workspace }}/vcpkg/bincache
+    # Let's use GitHub Action cache as storage for the vcpkg Binary Caching feature.
+    VCPKG_BINARY_SOURCES: 'clear;x-gha,readwrite'
   build:
     name: Build and Upload Artifacts
     runs-on: windows-latest
-    steps:
-    # Get dependencies
-    - name: Checkout code
-      uses: actions/checkout@v3
+     env:
+      # Indicates the location of the vcpkg as a Git submodule of the project repository.
+      # Not using "VCPKG_ROOT" because a variable with the same name is defined in the VS's
+      # Developer Command Prompt environment in VS 2022 17.6, which would override this one
+      # if it had the same name.
+      _VCPKG_: ${{ github.workspace }}/vcpkg
+      # Tells vcpkg where binary packages are stored.
+      VCPKG_DEFAULT_BINARY_CACHE: ${{ github.workspace }}/vcpkg/bincache
+      # Let's use GitHub Action cache as storage for the vcpkg Binary Caching feature.
+      VCPKG_BINARY_SOURCES: 'clear;x-gha,readwrite'
 
-    - name: Install dependencies via vcpkg
-      run: vcpkg.exe install --triplet x64-windows
+    steps:
+    # Set env vars needed for vcpkg to leverage the GitHub Action cache as a storage
+    # for Binary Caching.
+    - uses: actions/github-script@v7
+      with:
+        script: |
+          core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+          core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 
-    - name: Cache vcpkg
-      uses: actions/cache@v3
+    - uses: actions/checkout@v4
       with:
-        path: |
-          vcpkg
-          vcpkg_installed
-        key: ${{ runner.os }}-vcpkg-${{ hashFiles('vcpkg.json') }}
+        submodules: true
+    - name: "Create directory '${{ env.VCPKG_DEFAULT_BINARY_CACHE }}'"
+      run: mkdir -p $VCPKG_DEFAULT_BINARY_CACHE
+      shell: bash
 
-    - name: Get Ninja
-      uses: seanmiddleditch/gha-setup-ninja@master
+    # Setup the build machine with the most recent versions of CMake and Ninja. Both are cached if not already: on subsequent runs both will be quickly restored from GitHub cache service.
+    - uses: lukka/get-cmake@latest
 
-    - name: Set up CMake
-      uses: jwlawson/actions-setup-cmake@v1
+    # Restore vcpkg from the GitHub Action cache service. Note that packages are restored by vcpkg's binary caching
+    # when it is being run afterwards by CMake.
+    - name: Restore vcpkg
+      uses: actions/cache@v4
       with:
-        cmake-version: '3.16'
+        # The first path is the location of vcpkg: it contains the vcpkg executable and data files, as long as the
+        # built package archives (aka binary cache) which are located by VCPKG_DEFAULT_BINARY_CACHE env var.
+        # The other paths starting with '!' are exclusions: they contain termporary files generated during the build of the installed packages.
+        path: |
+          ${{ env._VCPKG_ }}
+          !${{ env._VCPKG_ }}/buildtrees
+          !${{ env._VCPKG_ }}/packages
+          !${{ env._VCPKG_ }}/downloads
+          !${{ env._VCPKG_ }}/installed
+        # The key is composed in a way that it gets properly invalidated whenever a different version of vcpkg is being used.
+        key: |
+          ${{ hashFiles( '.git/modules/vcpkg/HEAD' )}}
 
-    - name: Set up MSVC environment
-      shell: cmd
-      run: |
-        call "%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -latest -property installationPath > vs_install_dir.txt
-        set /p InstallDir=<vs_install_dir.txt
-        call "%InstallDir%\VC\Auxiliary\Build\vcvarsall.bat" x64
+    # On Windows runners, let's ensure to have the Developer Command Prompt environment setup correctly.
+    # As used here the Developer Command Prompt created is targeting x64 and using the default the Windows SDK.
+    - uses: ilammy/msvc-dev-cmd@v1
 
     # Configure CMake (Windows)
     - name: Configure CMake (Windows)
       shell: cmd
       run: |
-        cmake -B build -S . -G Ninja -DCMAKE_BUILD_TYPE=Release
+        cmake --preset ninja-multi-vcpkg -B build -S . -G Ninja -DCMAKE_BUILD_TYPE=Release
 
     # 4. Build the project
     - name: Build PlatypusGui
-      run: cmake --build build --config Release --target PlatypusGui
+      run: cmake --preset ninja-vcpkg-release --build build --config Release --target PlatypusGui
 
     - name: Deploy Qt Dependencies (Windows)
       shell: cmd

CMakePresets.json

@@ -0,0 +1,65 @@
+{
+  "version": 8,
+  "cmakeMinimumRequired": {
+      "major": 3,
+      "minor": 21,
+      "patch": 0
+  },
+  "configurePresets": [
+      {
+          "name": "ninja-multi-vcpkg",
+          "displayName": "Ninja Multi-Config",
+          "description": "Configure with vcpkg toolchain and generate Ninja project files for all configurations",
+          "binaryDir": "${sourceDir}/builds/${presetName}",
+          "generator": "Ninja Multi-Config",
+          "toolchainFile": "${sourceDir}/vcpkg/scripts/buildsystems/vcpkg.cmake"
+      }
+  ],
+  "buildPresets": [
+      {
+          "name": "ninja-vcpkg-debug",
+          "configurePreset": "ninja-multi-vcpkg",
+          "displayName": "Build (Debug)",
+          "description": "Build with Ninja/vcpkg (Debug)",
+          "configuration": "Debug"
+      },
+      {
+          "name": "ninja-vcpkg-release",
+          "configurePreset": "ninja-multi-vcpkg",
+          "displayName": "Build (Release)",
+          "description": "Build with Ninja/vcpkg (Release)",
+          "configuration": "Release"
+      },
+      {
+          "name": "ninja-vcpkg",
+          "configurePreset": "ninja-multi-vcpkg",
+          "displayName": "Build",
+          "description": "Build with Ninja/vcpkg"
+      }
+  ],
+  "testPresets": [
+      {
+          "name": "test-ninja-vcpkg",
+          "configurePreset": "ninja-multi-vcpkg",
+          "hidden": true
+      },
+      {
+          "name": "test-debug",
+          "description": "Test (Debug)",
+          "displayName": "Test (Debug)",
+          "configuration": "Debug",
+          "inherits": [
+              "test-ninja-vcpkg"
+          ]
+      },
+      {
+          "name": "test-release",
+          "description": "Test (Release)",
+          "displayName": "Test (Release)",
+          "configuration": "Release",
+          "inherits": [
+              "test-ninja-vcpkg"
+          ]
+      }
+  ]
+}

vcpkg.json

@@ -2,7 +2,7 @@
   "name": "platypus",
   "version": "0.0.1",
   "dependencies": [
-    "opencv4[core,default-features,fs,gapi,highgui,intrinsics,jpeg,png,quirc,thread,tiff]",
-    "qt5[activeqt,core,declarative,essentials,imageformats,multimedia,svg,tools,translations]:x64-windows"
+    "opencv4",
+    "qt5:x64-windows"
   ]
 }