tests.yaml

---
name: Tests
"on":
  push:
    branches:
      - main
  pull_request:
  schedule:
    # Run tests every Monday at 9:17 to catch regressions.
    - cron: "17 9 * * 1"

concurrency:
  # Group workflow jobs so new commits cancels in-progress execution triggered by previous commits. Source:
  # https://mail.python.org/archives/list/pypa-committers@python.org/thread/PCBCQMJF64JGRBOX7E2EE4YLKHT4DI55/
  # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/control-the-concurrency-of-workflows-and-jobs
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

jobs:

  tests:
    strategy:
      fail-fast: false
      matrix:
        # Available OS: https://github.com/actions/runner-images#available-images
        os:
          - ubuntu-24.04     # x86
          - ubuntu-24.04-arm # arm64
          - ubuntu-22.04     # x86
          - ubuntu-22.04-arm # arm64
          - macos-15         # arm64
          - macos-13         # x86
          - windows-2025     # x86
          - windows-2022     # x86
        # Available Python: https://github.com/actions/python-versions/blob/main/versions-manifest.json
        python-version:
          - "3.10"
          - "3.11"
          - "3.12"
          - "3.13"
          - "3.14"
        click-version:
          - released
          - stable
          - main
        cloup-version:
          - released
          - master
        # Removes from the matrix some combinations for development versions of Click and Cloup. This reduce the size
        # of the matrix for tests on non-released versions. While keeping the full exhaustive tests on the released
        # versions of Click and Cloup.
        exclude:
          # Exclude old OSes. Only keeps the latest OSes of each family.
          - os: ubuntu-22.04
            click-version: stable
          - os: ubuntu-22.04
            click-version: main
          - os: ubuntu-22.04
            cloup-version: master
          - os: ubuntu-22.04-arm
            click-version: stable
          - os: ubuntu-22.04-arm
            click-version: main
          - os: ubuntu-22.04-arm
            cloup-version: master
          - os: macos-13
            click-version: stable
          - os: macos-13
            click-version: main
          - os: macos-13
            cloup-version: master
          - os: windows-2022
            click-version: stable
          - os: windows-2022
            click-version: main
          - os: windows-2022
            cloup-version: master
          # Exclude old Python version. Only test on latest stable release.
          - python-version: "3.10"
            click-version: stable
          - python-version: "3.10"
            click-version: main
          - python-version: "3.10"
            cloup-version: master
          - python-version: "3.11"
            click-version: stable
          - python-version: "3.11"
            click-version: main
          - python-version: "3.11"
            cloup-version: master
          - python-version: "3.12"
            click-version: stable
          - python-version: "3.12"
            click-version: main
          - python-version: "3.12"
            cloup-version: master
          # Exclude Python's dev version.
          - python-version: "3.14"
            click-version: stable
          - python-version: "3.14"
            click-version: main
          - python-version: "3.14"
            cloup-version: master
        include:
          # Default all jobs as stable, unless marked otherwise below.
          - state: stable
    name: |
      ${{ matrix.state == 'stable' && '✅' || '⁉️' }}
      ${{ matrix.os }},
      py${{ matrix.python-version }},
      Click ${{ matrix.click-version }},
      Cloup ${{ matrix.cloup-version }}
    runs-on: ${{ matrix.os }}
    # We keep going when a job flagged as not stable fails.
    continue-on-error: ${{ matrix.state == 'unstable' }}
    steps:
      - uses: actions/checkout@v4.2.2
      - name: Install uv
        run: |
          python -m pip install -r https://raw.githubusercontent.com/kdeldycke/workflows/v4.14.2/requirements/uv.txt
      - name: Install project
        run: |
          uv --no-progress venv --python ${{ matrix.python-version }}
          uv --no-progress sync --frozen --extra test --extra pygments --extra sphinx --extra pytest
      - name: Unittests
        run: >
          uv --no-progress run --frozen
          ${{ matrix.click-version != 'released'
          && format('--with "git+https://github.com/pallets/click.git@{0}"', matrix.click-version) || '' }}
          ${{ matrix.cloup-version != 'released'
          && format('--with "git+https://github.com/janluke/cloup.git@{0}"', matrix.cloup-version) || ''}}
          --
          pytest
      - name: Codecov - coverage
        uses: codecov/codecov-action@v5.4.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
      - name: Codecov - test results
        if: ${{ !cancelled() }}
        uses: codecov/test-results-action@v1.0.4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}