tests.yml

# SPDX-FileCopyrightText: 2026 calendaring-sync contributors
# SPDX-License-Identifier: AGPL-3.0-or-later

name: Tests

on:
  push:
    branches: [main]
  pull_request:
    types: [opened, synchronize, reopened, labeled, unlabeled]
  workflow_call:

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

permissions:
  contents: read

jobs:
  changelog:
    name: Check for a news fragment
    if: >-
      github.event_name == 'pull_request' &&
      !contains(github.event.pull_request.labels.*.name, 'skip-changelog')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: "3.15"
          pip-version: "26.2.2"

      - name: Install towncrier
        run: pip install towncrier==26.9.0

      - name: Check for a news fragment
        run: towncrier check --compare-with origin/${GITHUB_BASE_REF}

  lint:
    name: Lint with Ruff
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: "3.15"
          pip-version: "26.2.2"

      - name: Install ruff
        run: pip install ruff==0.17.2

      - name: Lint code
        run: ruff check .

      - name: Check code format
        run: ruff format --check .

  vale:
    name: Check docs prose with Vale
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: "3.15"
          pip-version: "26.2.2"

      - name: Install docutils
        run: pip install docutils==0.23

      - name: Install Vale
        run: |
          curl -sL https://github.com/errata-ai/vale/releases/download/v3.25.1/vale_3.25.1_Linux_64-bit.tar.gz | tar -xz -C /usr/local/bin vale

      - name: Sync Vale styles
        run: vale sync

      - name: Lint docs
        run: vale --no-exit docs/

  docs:
    name: Build docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          # Read the Docs builds with 3.14, its newest Python.
          python-version: "3.14"
          pip-version: "26.2.2"

      - name: Install dependencies
        run: pip install -e ".[docs]"

      - name: Build docs
        run: sphinx-build -W -b html docs docs/_build/html

      - name: Check links
        run: sphinx-build -b linkcheck docs docs/_build/linkcheck

  mypy:
    name: Type check with mypy
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: "3.15"
          pip-version: "26.2.2"

      - name: Install dependencies
        run: pip install -e ".[dev]"

      - name: Type check
        # Its settings are in pyproject.toml.
        run: python -m mypy src/calendaring_sync docs/examples tests/docker

  test:
    name: Test on Python ${{ matrix.python-version }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write # required for tokenless Codecov upload via OIDC
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]

    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
          fetch-depth: 0

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: ${{ matrix.python-version }}
          pip-version: "26.2.2"

      - name: Install dependencies
        run: pip install -e ".[dev]"

      - name: Run tests
        run: |
          pytest --cov --cov-branch --cov-report=xml \
            --junitxml=junit.xml -o junit_family=legacy \
            src/calendaring_sync/tests --ignore-glob="*_integration.py"

      - name: Upload coverage to Codecov
        if: ${{ !cancelled() }}
        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
        with:
          use_oidc: true
          files: ./coverage.xml
          flags: python-${{ matrix.python-version }}
          skip_validation: true
          fail_ci_if_error: false

      - name: Upload test results to Codecov
        if: ${{ !cancelled() }}
        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
        with:
          use_oidc: true
          files: ./junit.xml
          flags: python-${{ matrix.python-version }}
          report_type: test_results
          skip_validation: true
          fail_ci_if_error: false