ci.yml

name: CI

on:
  pull_request:
    types: [opened, synchronize, reopened]
  push:
    branches: [master, windows]
    paths-ignore:
      - "website/**"
      - ".github/APPROVED_CONTRIBUTORS"

permissions:
  contents: read

env:
  RUST_TOOLCHAIN_VERSION: 1.96.1

concurrency:
  group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  conventional-commits:
    if: github.event_name != 'push' || github.ref_name == 'master'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Validate commit subjects
        if: github.event_name == 'push'
        run: python3 scripts/conventional_commits.py --range "${{ github.event.before }}..${{ github.event.after }}"

      - name: Validate PR title
        if: github.event_name == 'pull_request'
        run: python3 scripts/conventional_commits.py "${{ github.event.pull_request.title }}"

  check:
    name: check (${{ matrix.os }})
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: ubuntu-latest
            kind: unix
            nextest_filter: all()
          - os: macos-latest
            kind: unix
            nextest_filter: not binary(live_handoff)
          - os: windows-latest
            kind: windows
    runs-on: ${{ matrix.os }}
    timeout-minutes: 15
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          persist-credentials: false

      - name: Install Rust
        if: matrix.kind == 'unix'
        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # v1
        with:
          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
          components: rustfmt,clippy

      - name: Install Rust
        if: matrix.kind == 'windows'
        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # v1
        with:
          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
          components: rustfmt,clippy
          targets: x86_64-pc-windows-msvc

      - name: Install Rust tools
        if: matrix.kind == 'unix'
        uses: taiki-e/install-action@fd2f5e3d644b484055ebf4268f474c565f148f25 # v2.81.9
        with:
          tool: just,cargo-nextest

      - name: Install Bun
        if: matrix.kind == 'unix'
        uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
        with:
          bun-version: 1.3.14

      - name: Install Zig
        if: runner.os != 'macOS'
        uses: mlugg/setup-zig@d1434d08867e3ee9daa34448df10607b98908d29 # v2.2.1
        with:
          version: 0.15.2
          use-cache: ${{ matrix.kind != 'windows' }}

      - name: Restore Homebrew Zig cache
        if: runner.os == 'macOS'
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: ~/Library/Caches/Homebrew/downloads
          key: homebrew-zig-0.15-${{ runner.os }}-${{ runner.arch }}
          restore-keys: |
            homebrew-zig-0.15-${{ runner.os }}-

      - name: Install patched Zig on macOS
        if: runner.os == 'macOS'
        run: |
          HOMEBREW_NO_AUTO_UPDATE=1 brew install zig@0.15
          echo "$(brew --prefix zig@0.15)/bin" >> "$GITHUB_PATH"
          echo "ZIG_GLOBAL_CACHE_DIR=$GITHUB_WORKSPACE/.zig-cache" >> "$GITHUB_ENV"
          echo "ZIG_LOCAL_CACHE_DIR=$GITHUB_WORKSPACE/.zig-cache" >> "$GITHUB_ENV"
          "$(brew --prefix zig@0.15)/bin/zig" version

      - name: Restore Zig build cache
        if: runner.os == 'macOS' || matrix.kind == 'windows'
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: .zig-cache
          key: zig-build-v1-${{ runner.os }}-${{ runner.arch }}-0.15.2-${{ github.run_id }}-${{ github.run_attempt }}
          restore-keys: |
            zig-build-v1-${{ runner.os }}-${{ runner.arch }}-0.15.2-

      - name: Install macOS build tools
        if: runner.os == 'macOS'
        run: HOMEBREW_NO_AUTO_UPDATE=1 brew install cmake ninja

      - name: Restore cargo cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
        with:
          cache-bin: false
          key: ${{ matrix.os }}

      - name: Run checks
        if: matrix.kind == 'unix'
        run: just ci '${{ matrix.nextest_filter }}'

      - name: Run Windows checks
        if: matrix.kind == 'windows'
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"
          function Invoke-Checked {
            param([string]$Command, [string[]]$Arguments)
            & $Command @Arguments
            if ($LASTEXITCODE -ne 0) {
              throw "command failed with exit code $LASTEXITCODE`: $Command $($Arguments -join ' ')"
            }
          }
          function Invoke-CargoWithZigCacheRecovery {
            param([string[]]$Arguments)
            & cargo @Arguments
            if ($LASTEXITCODE -eq 0) {
              return
            }

            Write-Warning "cargo compile failed; clearing Zig build caches and retrying once"
            Remove-Item -Recurse -Force .zig-cache -ErrorAction SilentlyContinue
            Remove-Item -Recurse -Force vendor/libghostty-vt/.zig-cache -ErrorAction SilentlyContinue
            Remove-Item -Recurse -Force vendor/libghostty-vt/zig-out -ErrorAction SilentlyContinue
            Invoke-Checked cargo $Arguments
          }
          Invoke-Checked cargo @("fmt", "--check")
          Invoke-CargoWithZigCacheRecovery @("clippy", "--bin", "herdr", "--locked", "--target", "x86_64-pc-windows-msvc", "--", "-D", "warnings")
          Invoke-Checked cargo @("test", "--locked", "--target", "x86_64-pc-windows-msvc", "--bin", "herdr", "windows_")
          Invoke-Checked cargo @("test", "--locked", "--target", "x86_64-pc-windows-msvc", "--bin", "herdr", "server::client_transport::tests")
          Invoke-Checked cargo @("build", "--locked", "--target", "x86_64-pc-windows-msvc")

      - name: Smoke ConPTY pane
        if: matrix.kind == 'windows'
        shell: pwsh
        run: |
          $ErrorActionPreference = "Stop"
          $exe = Join-Path $PWD "target\x86_64-pc-windows-msvc\debug\herdr.exe"
          .\scripts\windows_smoke_conpty_path.ps1 -ExePath $exe -Session "ci-windows-$env:GITHUB_RUN_ID-$env:GITHUB_RUN_ATTEMPT"