pre-commit.yml

# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# SPDX-License-Identifier: Apache-2.0

name: "CI: pre-commit"

on:
  pull_request:
    types: [opened, reopened, synchronize]
  push:
    # PR events cover draft and fork PRs without also checking copy-pr-bot's
    # pull-request/N mirrors. Only the default branch needs a push check, and
    # it is the only ref that refreshes the saved cache (see the save step).
    branches:
      - "main"
      - "ctk-next"
  workflow_dispatch: {}

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

permissions:
  contents: read

defaults:
  run:
    shell: bash --noprofile --norc -xeuo pipefail {0}

jobs:
  pre-commit:
    name: Pre-commit (${{ matrix.name }})
    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Linux
            os: ubuntu-latest
          - name: Windows
            os: windows-latest
    env:
      # Full-CI docs builds and nightly check links. The installation reminder
      # is for developer machines; CI does not install a Git commit hook.
      SKIP: lychee,check-precommit-installed
      # Minor version used by setup-python and as the cache restore-key prefix.
      PYTHON_VERSION: "3.14"
    steps:
      - name: Enable Git symlinks (Windows, must precede checkout)
        if: runner.os == 'Windows'
        run: git config --global core.symlinks true

      # PR workflows run from the merge revision; check out that same revision
      # so their helper scripts and configuration stay in sync.
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          fetch-depth: 1
          persist-credentials: false

      - name: Set up Python
        id: python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97  # v7.0.0
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Set pre-commit cache location
        run: echo "PRE_COMMIT_HOME=${RUNNER_TEMP}/pre-commit" >> "${GITHUB_ENV}"

      - name: Restore pre-commit cache
        id: precommit-cache
        uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9  # v6.1.0
        with:
          path: ${{ env.PRE_COMMIT_HOME }}
          # The full patch version keeps the key exact, so a patch bump misses
          # and re-saves. The minor-version restore-key still partially hits on
          # that bump, so hooks rebuild from a warm cache instead of cold. The
          # prefix stops at the minor with no trailing separator, so it is a
          # prefix of "py3.14.<patch>-..." regardless of the separator that
          # follows the resolved version.
          key: pre-commit-${{ runner.os }}-py${{ steps.python.outputs.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}
          restore-keys: |
            pre-commit-${{ runner.os }}-py${{ env.PYTHON_VERSION }}

      - name: Install pre-commit
        run: python -m pip install --upgrade pip pre-commit

      # Keep this offline hook smoke check before network-dependent Lychee steps,
      # so hook setup and invocation failures surface before link-check retries.
      # Invoke pre-commit directly to cover each shell's command lookup and quoting.
      # Each runner's shells reuse one offline configuration and hook environment.
      - name: Prepare offline Lychee configuration
        id: lychee-smoke
        # pre-commit needs the config on the checkout's drive; spaces exercise quoting.
        run: |
          directory="$(mktemp -d 'lychee offline smoke XXXXXX')"
          echo "directory=$directory" >> "${GITHUB_OUTPUT}"
          python ci/tools/smoke_test_lychee_precommit.py --prepare "$directory"

      - name: Smoke-test Lychee in ${{ runner.os == 'Windows' && 'Git Bash' || 'Bash' }}
        if: ${{ !cancelled() && steps.lychee-smoke.outcome == 'success' }}
        shell: bash
        env:
          LYCHEE_SMOKE_DIR: ${{ steps.lychee-smoke.outputs.directory }}
          SKIP: ""
          PYTHONUTF8: "1"
        run: |
          status=0
          pre-commit run lychee --config "$LYCHEE_SMOKE_DIR/pre-commit.yaml" --files README.md --verbose > "$LYCHEE_SMOKE_DIR/bash.log" 2>&1 || status=$?
          python ci/tools/smoke_test_lychee_precommit.py --verify "$LYCHEE_SMOKE_DIR/bash.log" "$status"

      - name: Smoke-test Lychee in PowerShell (Windows)
        if: ${{ !cancelled() && runner.os == 'Windows' && steps.lychee-smoke.outcome == 'success' }}
        shell: pwsh
        env:
          LYCHEE_SMOKE_DIR: ${{ steps.lychee-smoke.outputs.directory }}
          SKIP: ""
          PYTHONUTF8: "1"
        run: |
          pre-commit run lychee --config "$env:LYCHEE_SMOKE_DIR/pre-commit.yaml" --files README.md --verbose > "$env:LYCHEE_SMOKE_DIR/pwsh.log" 2>&1
          python ci/tools/smoke_test_lychee_precommit.py --verify "$env:LYCHEE_SMOKE_DIR/pwsh.log" $LASTEXITCODE

      - name: Smoke-test Lychee in cmd (Windows)
        if: ${{ !cancelled() && runner.os == 'Windows' && steps.lychee-smoke.outcome == 'success' }}
        shell: cmd
        env:
          LYCHEE_SMOKE_DIR: ${{ steps.lychee-smoke.outputs.directory }}
          SKIP: ""
          PYTHONUTF8: "1"
        run: |
          pre-commit run lychee --config "%LYCHEE_SMOKE_DIR%\pre-commit.yaml" --files README.md --verbose > "%LYCHEE_SMOKE_DIR%\cmd.log" 2>&1
          python ci/tools/smoke_test_lychee_precommit.py --verify "%LYCHEE_SMOKE_DIR%\cmd.log" %ERRORLEVEL%

      - name: Remove offline Lychee configuration
        if: ${{ always() && steps.lychee-smoke.outputs.directory != '' }}
        env:
          LYCHEE_SMOKE_DIR: ${{ steps.lychee-smoke.outputs.directory }}
        run: python ci/tools/smoke_test_lychee_precommit.py --cleanup "$LYCHEE_SMOKE_DIR"

      - name: Run pre-commit
        run: pre-commit run --all-files --show-diff-on-failure

      - name: Save pre-commit cache
        # Only the default branch saves, so per-PR merge refs don't store their
        # own duplicate copies. !cancelled() keeps a push that fails lint from
        # discarding the valid hook environments. Skipping on an exact key hit
        # avoids re-saving identical content; a patch-bump partial hit still
        # saves because cache-hit is only 'true' on an exact match.
        if: ${{ !cancelled() && github.ref_name == github.event.repository.default_branch && steps.precommit-cache.outputs.cache-hit != 'true' }}
        uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9  # v6.1.0
        with:
          path: ${{ env.PRE_COMMIT_HOME }}
          key: pre-commit-${{ runner.os }}-py${{ steps.python.outputs.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}