main.yml

name: Tests

env:
  POETRY_VERSION: "1.7.1"
  PYTHON_VERSION: "3.12"

on:
  merge_group:
  push:
  pull_request:

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v5.3.0
        with:
          python-version: "${{ env.PYTHON_VERSION }}"

      - name: Install poetry
        shell: bash
        run: |
          pip install poetry==${POETRY_VERSION}

      - name: Run tox
        shell: bash
        run: |
          poetry install
          poetry run tox -e lint

  tests:
    name: Test with Python ${{ matrix.python_version }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
      fail-fast: false
    steps:
      - uses: actions/checkout@v4

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

      - name: Install poetry
        shell: bash
        run: |
          pip install poetry==${POETRY_VERSION}

      - name: Run tox
        shell: bash
        run: |
          poetry install
          poetry run tox -e coverage
        env:
          COVERAGE_FILE: ".coverage.${{ matrix.python_version }}"

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

  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    permissions:
      # Gives the action the necessary permissions for looking up the workflow that launched this workflow, and download the related artifact that contains the comment to be published
      actions: read
      # Gives the action the necessary permissions for editing existing comments (to avoid publishing multiple comments in the same PR)
      contents: write
      # Gives the action the necessary permissions for publishing new comments in pull requests.
      pull-requests: write
    needs: tests
    steps:
      - uses: actions/checkout@v4

      - uses: actions/download-artifact@v4
        id: download
        with:
          pattern: coverage-*
          merge-multiple: true

      - name: Coverage comment
        id: coverage_comment
        uses: py-cov-action/python-coverage-comment-action@v3.29
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          MERGE_COVERAGE_FILES: true

      - name: Store Pull Request comment to be posted
        uses: actions/upload-artifact@v4
        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
        with:
          name: python-coverage-comment-action
          path: python-coverage-comment-action.txt