build-and-release-windows.yml

name: Build and Release PlatypusGui

on:
  push:
    branches:
      - 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
    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'

    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 || '');

    - uses: actions/checkout@v4
      with:
        submodules: true
    - name: "Create directory '${{ env.VCPKG_DEFAULT_BINARY_CACHE }}'"
      run: mkdir -p $VCPKG_DEFAULT_BINARY_CACHE
      shell: bash

    # 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

    # 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:
        # 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' )}}

    # 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 --preset ninja-multi-vcpkg -B build -S . -G Ninja -DCMAKE_BUILD_TYPE=Release

    # 4. Build the project
    - name: Build PlatypusGui
      run: cmake --preset ninja-vcpkg-release --build build --config Release --target PlatypusGui

    - name: Deploy Qt Dependencies (Windows)
      shell: cmd
      run: |
        set QT_DIR=C:\Qt\5.15.2\msvc2019_64
        set PATH=%QT_DIR%\bin;%PATH%
        windeployqt.exe --compiler-runtime --dir build\deployment build\PlatypusGui.exe

    # 6. Upload artifacts for release
    - name: Upload Release Artifacts
      uses: actions/upload-artifact@v3
      with:
        name: windows-latest-platypus
        path: build\deployment\PlatypusGui.exe