ci.yml

---
name: CI

on:  # yamllint disable-line rule:truthy
  push:
    branches:
      - main
    tags:
      - v*.*.*
  pull_request:
    branches:
      - main
  workflow_dispatch:

jobs:

  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python_version:
          - '3.9'
          - '3.10'
          - '3.11'
          - '3.12'

    steps:

      - name: Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: Setup Python
        uses: actions/setup-python@v5.3.0
        with:
          python-version: ${{ matrix.python_version }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install tox-gh-actions

      - name: Run tox
        env:
          COVERAGE_FILE: .coverage.${{ matrix.python_version }}
        run: tox

      - name: Store the coverage report
        uses: actions/upload-artifact@v4.4.3
        with:
          include-hidden-files: true
          name: coverage-${{ matrix.python_version }}
          path: .coverage.${{ matrix.python_version }}

  coverage:

    runs-on: ubuntu-latest
    needs: build
    permissions:
      pull-requests: write
      contents: write

    steps:

      - name: Checkout the repository
        uses: actions/checkout@v4.2.2

      - name: Retrieve the coverage reports
        id: download
        uses: actions/download-artifact@v4.1.8
        with:
          pattern: coverage-*
          merge-multiple: true

      - name: Process the coverage reports
        id: coverage_processing
        uses: py-cov-action/python-coverage-comment-action@v3.29
        with:
          COVERAGE_DATA_BRANCH: 'COVERAGE-REPORT'
          GITHUB_TOKEN: ${{ github.token }}
          MERGE_COVERAGE_FILES: true

      - name: Store the pull request coverage comment for later posting
        if: steps.coverage_processing.outputs.COMMENT_FILE_WRITTEN == 'true'
        uses: actions/upload-artifact@v4.4.3
        with:
          name: python-coverage-comment-action
          path: python-coverage-comment-action.txt