ci.yml

# Multi-platform build & test workflow.
# Ensures BCSV compiles with zero warnings and all tests pass on:
#   Linux (GCC + Clang), Windows (MSVC), macOS (Apple Clang)
# Also covers the Python bindings and the cross-package version stamps.
#
# ON-DEMAND ONLY: this workflow runs on manual dispatch and on a weekly
# schedule — never on push or pull_request. Routine commit/push/sync cycles
# between machines must not burn runners. Trigger it manually whenever a
# second opinion is wanted (e.g. confirm the Windows and macOS builds from a
# Linux development kit: Actions → CI → Run workflow); the weekly schedule
# keeps master honest. Release correctness does NOT depend on any trigger
# here: the Release Ship hub (release-publish.yml) refuses to publish unless
# every packager tag run — which builds and tests Linux, Windows and macOS
# on its own — has concluded green first.

name: CI

on:
  schedule:
    - cron: '0 3 * * 1'   # Weekly Monday 3 AM UTC — Release builds
  workflow_dispatch:

permissions:
  contents: read

jobs:

  # Cheap guard that runs on every CI run: the committed manifests are
  # patched from VERSION.txt only at pack time, so nothing else notices when
  # they drift. unity/package.json sat at 1.5.3 for nine releases before this.
  # On a tag the Release hub re-checks this before publishing anything.
  version-consistency:
    name: Version consistency
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
        with:
          fetch-depth: 0
      - name: Check every version stamp against VERSION.txt
        run: python3 scripts/check_versions.py

  # The NuGet and Unity C# bindings are the same code in two namespaces and
  # cannot be merged into one source: NuGet publishes `namespace Bcsv;` and
  # Unity's asmdef publishes `namespace BCSV`, so unifying them would break
  # every consumer of the published package. This notices when the two copies
  # stop agreeing — which they had, in five places, before the check existed.
  csharp-binding-parity:
    name: C# binding parity
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
      - name: Compare the NuGet and Unity bindings
        run: python3 scripts/check_csharp_parity.py --verbose

  # ────────────────────────────────────────────────────────────────
  # pybcsv — every CI run
  #
  # python/tests/ is NOT registered with ctest (only tests/integration/*.py
  # is), so without this job the entire Python suite -- including the Parquet
  # transcoders -- ran only in the tag-driven publish workflow. A regression
  # then landed on master and surfaced mid-release. See VERSIONING.md on
  # lock step: the channel that changes most often needs a per-PR gate.
  # ────────────────────────────────────────────────────────────────
  pybcsv:
    name: pybcsv (Python bindings + tests)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
        with:
          # setuptools-scm derives the wheel version from tags; a shallow
          # clone hides them (see VERSIONING.md, Troubleshooting).
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: '3.12'

      - name: Install build and test dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install pytest pandas numpy pyarrow polars

      - name: Build and install pybcsv
        run: python -m pip install ./python -v

      - name: Run the pybcsv test suite
        run: python -m pytest python/tests/ -v --tb=short

  # ────────────────────────────────────────────────────────────────
  # Debug builds — every CI run (manual dispatch / weekly schedule)
  # ────────────────────────────────────────────────────────────────
  build:
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Linux GCC
            os: ubuntu-latest
            compiler: gcc
            configure-preset: ninja-debug
            build-preset: ninja-debug-build
            build-dir: build/ninja-debug

          - name: Linux Clang
            os: ubuntu-latest
            compiler: clang
            configure-preset: clang-debug
            build-preset: clang-debug-build
            build-dir: build/clang-debug

          # Ninja rather than the "Visual Studio 17 2022" generator presets:
          # windows-latest no longer ships VS 2022, so those presets fail at
          # configure with "could not find any instance of Visual Studio".
          # setup-msvc-dev (below) puts cl.exe on PATH, which is all Ninja needs,
          # and this stops CI depending on a specific VS major version.
          # These presets are single-config, so no cmake-config is required.
          - name: Windows MSVC
            os: windows-latest
            compiler: msvc
            configure-preset: ninja-msvc-debug
            build-preset: ninja-msvc-debug-build
            build-dir: build/ninja-msvc-debug

          - name: macOS Apple Clang
            os: macos-latest
            compiler: apple-clang
            configure-preset: ninja-debug
            build-preset: ninja-debug-build
            build-dir: build/ninja-debug

    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    name: ${{ matrix.name }}

    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

      - name: Install Ninja (Linux)
        if: runner.os == 'Linux'
        run: sudo apt-get update -q && sudo apt-get install -y -q ninja-build

      - name: Install Clang (Linux)
        if: matrix.compiler == 'clang'
        run: sudo apt-get install -y -q clang

      - name: Install Ninja (macOS)
        if: runner.os == 'macOS'
        run: brew install ninja

      # The Windows matrix entries use the Ninja MSVC presets (see the note
      # there). Ninja ships with some runner images and not others, so install
      # it rather than depend on the image.
      - name: Install Ninja (Windows)
        if: runner.os == 'Windows'
        run: choco install ninja -y --no-progress

      - name: Setup MSVC
        if: matrix.compiler == 'msvc'
        uses: TheMrMilchmann/setup-msvc-dev@368ef7d1ee4d1171b31d4a7f67f4d954f903f5a9 # v4
        with:
          arch: x64

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: '3.12'

      - name: Cache CMake dependencies
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
        with:
          path: ${{ matrix.build-dir }}/_deps
          key: deps-${{ matrix.os }}-${{ matrix.compiler }}-${{ hashFiles('**/**/CMakeLists.txt') }}

      - name: Configure
        run: cmake --preset ${{ matrix.configure-preset }} -DPython3_ROOT_DIR="${{ env.pythonLocation }}"

      - name: Build
        run: cmake --build --preset ${{ matrix.build-preset }} --parallel

      - name: Install pytest
        run: python -m pip install pytest

      # Every matrix entry is a single-config Ninja preset, so no -C.
      - name: Test
        run: ctest --test-dir ${{ matrix.build-dir }} --output-on-failure

  # ────────────────────────────────────────────────────────────────
  # Release builds — weekly schedule + manual dispatch
  # ────────────────────────────────────────────────────────────────
  release-build:
    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Linux GCC (Release)
            os: ubuntu-latest
            compiler: gcc
            configure-preset: ninja-release
            build-preset: ninja-release-build
            build-dir: build/ninja-release

          - name: Linux Clang (Release)
            os: ubuntu-latest
            compiler: clang
            configure-preset: clang-release
            build-preset: clang-release-build
            build-dir: build/clang-release

          # See the Windows MSVC note in the debug matrix above.
          - name: Windows MSVC (Release)
            os: windows-latest
            compiler: msvc
            configure-preset: ninja-msvc-release
            build-preset: ninja-msvc-release-build
            build-dir: build/ninja-msvc-release

          - name: macOS Apple Clang (Release)
            os: macos-latest
            compiler: apple-clang
            configure-preset: ninja-release
            build-preset: ninja-release-build
            build-dir: build/ninja-release

    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    name: ${{ matrix.name }}

    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5

      - name: Install Ninja (Linux)
        if: runner.os == 'Linux'
        run: sudo apt-get update -q && sudo apt-get install -y -q ninja-build

      - name: Install Clang (Linux)
        if: matrix.compiler == 'clang'
        run: sudo apt-get install -y -q clang

      - name: Install Ninja (macOS)
        if: runner.os == 'macOS'
        run: brew install ninja

      # The Windows matrix entries use the Ninja MSVC presets (see the note
      # there). Ninja ships with some runner images and not others, so install
      # it rather than depend on the image.
      - name: Install Ninja (Windows)
        if: runner.os == 'Windows'
        run: choco install ninja -y --no-progress

      - name: Setup MSVC
        if: matrix.compiler == 'msvc'
        uses: TheMrMilchmann/setup-msvc-dev@368ef7d1ee4d1171b31d4a7f67f4d954f903f5a9 # v4
        with:
          arch: x64

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: '3.12'

      - name: Cache CMake dependencies
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
        with:
          path: ${{ matrix.build-dir }}/_deps
          key: deps-${{ matrix.os }}-${{ matrix.compiler }}-release-${{ hashFiles('**/**/CMakeLists.txt') }}

      - name: Configure
        run: cmake --preset ${{ matrix.configure-preset }} -DPython3_ROOT_DIR="${{ env.pythonLocation }}"

      - name: Build
        run: cmake --build --preset ${{ matrix.build-preset }} --parallel

      - name: Install pytest
        run: python -m pip install pytest

      # Every matrix entry is a single-config Ninja preset, so no -C.
      - name: Test
        run: ctest --test-dir ${{ matrix.build-dir }} --output-on-failure