Virtual-Display-Driver/.github/workflows/ci-validation.yml

---
name: Build Virtual Display Driver

on:
  pull_request:
  push:
    branches: [ main, master ]
    paths-ignore:
      - '**.md'
      - 'docs/**'
      - 'LICENSE*'
  workflow_dispatch:

concurrency:
  group: "${{ github.workflow }}-${{ github.ref }}"
  cancel-in-progress: true

env:
  BUILD_CONFIGURATION: Release
  VDD_SOLUTION: Virtual Display Driver (HDR)/MttVDD.sln

permissions:
  contents: read

jobs:
  build:
    # The WDK driver build is validated against VS 2022; windows-latest is moving to VS 2026.
    runs-on: windows-2022
    strategy:
      fail-fast: false
      matrix:
        platform: [x64, ARM64]

    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
        with:
          submodules: true

      - name: Setup MSBuild
        uses: microsoft/setup-msbuild@30375c66a4eea26614e0d39710365f22f8b0af57  # v3.0.0

      - name: Install Windows Driver Kit (IddCx headers)
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"
          choco install windowsdriverkit11 -y --no-progress
          if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }

      - name: Detect Windows SDK (windows.h)
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"

          $kitsRoot = $null
          try {
            $kitsRoot = (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows Kits\Installed Roots" -Name "KitsRoot10" -ErrorAction Stop).KitsRoot10
          } catch {
            $kitsRoot = Join-Path ${env:ProgramFiles(x86)} "Windows Kits\10\"
          }

          if (-not $kitsRoot -or -not (Test-Path $kitsRoot)) {
            throw "Windows Kits root not found: $kitsRoot"
          }

          $includeRoot = Join-Path $kitsRoot "Include"
          if (-not (Test-Path $includeRoot)) {
            throw "Windows Kits Include directory not found: $includeRoot"
          }

          $best =
            Get-ChildItem -Path $includeRoot -Directory -ErrorAction SilentlyContinue |
            Where-Object { $_.Name -match '^\d+\.\d+\.\d+\.\d+$' } |
            Where-Object { Test-Path (Join-Path $_.FullName "um\Windows.h") } |
            Sort-Object -Property Name -Descending |
            Select-Object -First 1

          if (-not $best) {
            throw "Could not find an SDK version directory containing um\\Windows.h under: $includeRoot"
          }

          $sdkVersion = $best.Name
          Write-Output "Using WindowsSdkDir: $kitsRoot"
          Write-Output "Using WindowsTargetPlatformVersion: $sdkVersion"
          "WINDOWS_SDK_DIR=$kitsRoot" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
          "WINDOWS_TARGET_PLATFORM_VERSION=$sdkVersion" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append

      - name: Build VDD (${{ matrix.platform }})
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"

          $sln = "${{ env.VDD_SOLUTION }}"
          if (-not (Test-Path $sln)) { throw "VDD solution file not found at: $sln" }

          # Pick an available UMDF WDF header version on the runner.
          # Kits can be laid out either versioned:
          #   Include\<sdk>\wdf\umdf\2.xx
          # or unversioned:
          #   Include\wdf\umdf\2.xx
          $umdfRoots = @(
            (Join-Path $env:WINDOWS_SDK_DIR ("Include\" + $env:WINDOWS_TARGET_PLATFORM_VERSION + "\wdf\umdf")),
            (Join-Path $env:WINDOWS_SDK_DIR "Include\wdf\umdf")
          ) | Where-Object { Test-Path $_ }

          if (-not $umdfRoots -or $umdfRoots.Count -eq 0) {
            throw "UMDF WDF include root not found under $env:WINDOWS_SDK_DIR (tried versioned + unversioned layouts)"
          }

          $umdfBest =
            $umdfRoots |
            ForEach-Object { Get-ChildItem -Path $_ -Directory -ErrorAction SilentlyContinue } |
            Where-Object { $_.Name -match '^\d+\.\d+$' } |
            Sort-Object -Property Name -Descending |
            Select-Object -First 1

          if (-not $umdfBest) { throw "No UMDF version directories found under: $($umdfRoots -join ', ')" }

          $umdfMinor = ($umdfBest.Name -split '\.')[1]
          Write-Output "Using UMDF version: $($umdfBest.Name) (minor=$umdfMinor) from $($umdfBest.FullName)"

          msbuild $sln `
            /m `
            /t:Build `
            /p:Configuration="${{ env.BUILD_CONFIGURATION }}" `
            /p:Platform="${{ matrix.platform }}" `
            /p:WindowsSdkDir="$env:WINDOWS_SDK_DIR" `
            /p:WindowsTargetPlatformVersion="$env:WINDOWS_TARGET_PLATFORM_VERSION" `
            /p:UMDF_VERSION_MINOR="$umdfMinor" `
            /p:EnableInfVerif=false `
            /p:RunApiValidator=false `
            /verbosity:minimal

      - name: Collect outputs
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"
          $outDir = "Virtual Display Driver (HDR)\${{ matrix.platform }}\${{ env.BUILD_CONFIGURATION }}\MttVDD"
          if (-not (Test-Path $outDir)) { throw "Build output directory not found: $outDir" }

          $dest = "artifacts\VDD\${{ matrix.platform }}"
          New-Item -ItemType Directory -Path $dest -Force | Out-Null
          Copy-Item "$outDir\*" -Destination $dest -Recurse -Force

      - name: Upload artifacts
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: VDD-${{ matrix.platform }}-${{ env.BUILD_CONFIGURATION }}
          path: artifacts/VDD/${{ matrix.platform }}/
          if-no-files-found: error