msvc-full-features-cmake.yml

name: Cataclysm Windows build (CMake + MSVC)

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths-ignore:
      - "android/**"
      - "build-data/osx/**"
      - "docs/**"
      - "doxygen_doc/**"
      - "gfx/**"
      - "lang/**"
      - "lgtm/**"
      - "tools/**"
      - "!tools/format/**"
      - "utilities/**"
      - "scripts/**"
      - "**.md"
      - "**.mdx"
  pull_request:
    branches:
      - main
    paths-ignore:
      - "android/**"
      - "build-data/osx/**"
      - "docs/**"
      - "doxygen_doc/**"
      - "gfx/**"
      - "lang/**"
      - "lgtm/**"
      - "tools/**"
      - "!tools/format/**"
      - "utilities/**"
      - "scripts/**"
      - "**.md"
      - "**.mdx"
# We only care about the latest revision, so cancel previous instances.
concurrency:
  group: msvc-cmake-build-${{ github.ref_name }}
  cancel-in-progress: true

env:
  VCPKG_BINARY_SOURCES: "clear;x-gha,readwrite"
  # There's not enough disk space to build both release and debug versions of
  # our dependencies, so we hack the triplet file to build only release versions
  # Have to use github.workspace because runner namespace isn't available yet.
  VCPKG_OVERLAY_TRIPLETS: ${{ github.workspace }}\.github\vcpkg_triplets
  ZSTD_CLEVEL: 17
  CMAKE_BUILD_DIR: out/build/windows-tiles-sounds-x64-msvc-tests

jobs:
  build_catatclysm:
    name: Build
    runs-on: windows-latest
    if: github.event.pull_request.draft == false

    steps:
      - name: checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Setup MSVC environment
        uses: ilammy/msvc-dev-cmd@v1
        with:
          arch: x64

      - name: Remove Strawberry Perl from PATH
        run: |
          echo $env:PATH
          echo =========================
          $env:PATH = $env:PATH -replace "C:\\Strawberry\\c\\bin;", ""
          $env:PATH = $env:PATH -replace "C:\\Strawberry\\perl\\site\\bin;", ""
          $env:PATH = $env:PATH -replace "C:\\Strawberry\\perl\\bin;", ""
          "PATH=$env:PATH" | Out-File -FilePath $env:GITHUB_ENV -Append
          echo =========================
          echo $env:PATH

      - name: Install stable CMake
        uses: lukka/get-cmake@v3.31.6

      # https://learn.microsoft.com/en-us/vcpkg/consume/binary-caching-github-actions-cache#1---export-required-github-actions-environment-variables
      - name: Export GitHub Actions cache environment variables
        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: Install vcpkg
        uses: lukka/run-vcpkg@main
        id: runvcpkg
        with:
          vcpkgDirectory: "${{ runner.workspace }}/b/vcpkg"

      - name: Integrate vcpkg
        run: |
          vcpkg integrate install

      - name: Export GitHub Actions cache environment variables
        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: Setup ccache
        uses: hendrikmuhs/ccache-action@v1.2
        with:
          key: msvc-cmake-windows-tiles-sounds-x64-msvc-${{ github.ref_name }}
          restore-keys: |
            msvc-cmake-windows-tiles-sounds-x64-msvc-${{ github.ref_name }}
            msvc-cmake-windows-tiles-sounds-x64-msvc-main
            msvc-cmake-windows-tiles-sounds-x64-msvc-
          max-size: 500M
          verbose: 2
          save: ${{ github.event_name != 'pull_request' }}

      - name: Configure ccache for MSVC
        run: |
          echo "CCACHE_BASEDIR=${{ github.workspace }}" >> $env:GITHUB_ENV
          echo "CCACHE_SLOPPINESS=include_file_ctime,include_file_mtime,time_macros,pch_defines" >> $env:GITHUB_ENV
          echo "CCACHE_NOHASHDIR=1" >> $env:GITHUB_ENV

      # build-scripts/windows-tiles-sounds-x64-msvc.cmake (CMAKE_PROJECT_INCLUDE_BEFORE)
      # bootstraps the MSVC toolchain via VsDevCmd.bat if not already in a VS environment,
      # and auto-detects ccache if present on PATH.
      - name: Configure CMake
        run: |
          cmake -G Ninja `
            -S "${{ github.workspace }}" `
            -B "${{ github.workspace }}/${{ env.CMAKE_BUILD_DIR }}" `
            -DCMAKE_BUILD_TYPE=RelWithDebInfo `
            -DCMAKE_PROJECT_INCLUDE_BEFORE="${{ github.workspace }}/build-scripts/windows-tiles-sounds-x64-msvc.cmake" `
            -DCMAKE_TOOLCHAIN_FILE="${{ github.workspace }}/build-scripts/MSVC.cmake" `
            -DVCPKG_TARGET_TRIPLET=x64-windows-static `
            -DDYNAMIC_LINKING=False `
            -DCMAKE_EXPORT_COMPILE_COMMANDS=ON `
            -DCURSES=False `
            -DLOCALIZE=True `
            -DTILES=True `
            -DSOUND=True `
            -DTESTS=True `
            -DJSON_FORMAT=OFF `
            -DCMAKE_INSTALL_MESSAGE=NEVER

      - name: Build
        run: |
          cmake --build "${{ github.workspace }}/${{ env.CMAKE_BUILD_DIR }}" `
            --target cataclysm-bn-tiles --target cata_test-tiles

      - name: Dump logs if build failed
        if: failure()
        run: |
          echo =================================================
          Get-ChildItem "${{ github.workspace }}/${{ env.CMAKE_BUILD_DIR }}" -Recurse
          echo =================================================

      - name: Compile .mo files for localization
        run: |
          cmake --build "${{ github.workspace }}/${{ env.CMAKE_BUILD_DIR }}" --target translations_compile

      - name: ccache stats
        run: |
          ccache -s -vv

      - name: Run tests
        run: |
          & "${{ github.workspace }}/${{ env.CMAKE_BUILD_DIR }}/tests/cata_test-tiles.exe" --rng-seed time