main.yml

name: main

on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Hatch
        run: pipx install hatch
      - name: Set up python 3.8
        uses: actions/setup-python@v5
        with:
          python-version: "3.8"
          cache: "pip"
          cache-dependency-path: "pyproject.toml"
      - name: Check formatting with black
        run: hatch run black --check
      - name: Check docstrings with darglint
        run: hatch run darglint
      - name: Type check with mypy
        run: hatch run mypy
      - name: Lint with ruff
        run: hatch run ruff

  test:
    runs-on: ${{ matrix.os }}-latest
    strategy:
      matrix:
        os: [ubuntu, macos, windows]
        python-version:
          - "3.8"
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
          - "pypy3.8"
          - "pypy3.9"
          - "pypy3.10"
      fail-fast: false
    steps:
      - uses: actions/checkout@v4
      - name: Install Hatch
        run: pipx install hatch
      - name: Set up python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          allow-prereleases: true
          cache: "pip"
          cache-dependency-path: "pyproject.toml"
      - name: Test with pytest
        env:
          COVERAGE_FILE: .coverage.${{ matrix.os }}.${{ matrix.python-version }}
        run: hatch run pytest-ci ${{ matrix.python-version }}
      - name: Upload coverage data
        uses: actions/upload-artifact@v4
        with:
          name: coverage-data-${{ matrix.os }}-${{ matrix.python-version }}
          path: .coverage.${{ matrix.os }}.${{ matrix.python-version }}

  coverage:
    runs-on: ubuntu-latest
    needs: test
    outputs:
      percentage: ${{ steps.percentage.outputs.percentage }}
    steps:
      - uses: actions/checkout@v4
      - name: Install Coverage.py
        run: pipx install coverage[toml]
      - name: Download coverage data
        uses: actions/download-artifact@v4
        with:
          pattern: coverage-data-*
          merge-multiple: true
      - name: Combine data
        run: coverage combine
      - name: Output coverage percentage
        id: percentage
        run: |
          coverage json
          echo "percentage=$(jq '.totals.percent_covered_display' coverage.json)" >> $GITHUB_OUTPUT
      - name: Save coverage report
        run: coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
      - name: Ensure 100% coverage
        run: coverage report --fail-under=100

  coverage-badge:
    runs-on: ubuntu-latest
    needs: coverage
    if: github.event_name == 'push' && github.ref_name == 'main'
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          ref: "coverage-badge"
      - name: Calculate badge color
        id: color
        run: |
          echo "color=$(python3 -Ic 'print(
            min(
              color
              for percentage, color in [
                (100, "brightgreen"),
                (90, "green"),
                (70, "yellowgreen"),
                (50, "yellow"),
                (30, "orange"),
                (0, "red"),
              ]
              if percentage >= int(${{ needs.coverage.outputs.percentage }})
            )
          )')" >> $GITHUB_OUTPUT
      - name: Update JSON file
        run: |
          jq -n \
            --argjson schemaVersion 1 \
            --arg label coverage \
            --arg message ${{ needs.coverage.outputs.percentage }}% \
            --arg color ${{ steps.color.outputs.color }} \
            '$ARGS.named' > coverage-badge.json
      - name: Create commit
        run: |
          git config user.name 'prns'
          git config user.email '77806190+prnss@users.noreply.github.com'
          git commit -am "Update coverage" && git push || true

  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Hatch
        run: pipx install hatch
      - name: Build project
        run: hatch build
      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          name: artifacts
          path: dist/*
          if-no-files-found: error

  pypi-publish:
    runs-on: ubuntu-latest
    needs:
      - lint
      - test
      - coverage
      - build
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
    environment: pypi-publish
    permissions:
      id-token: write
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v4
        with:
          name: artifacts
          path: dist
      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

  lint-spec-parser:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: spec_parser
    steps:
      - uses: actions/checkout@v4
      - name: Install Poetry
        run: pipx install poetry
      - name: Set up python 3.8
        uses: actions/setup-python@v5
        with:
          python-version: "3.8"
          cache: "poetry"
          cache-dependency-path: "spec_parser/poetry.lock"
      - name: Install dependencies
        run: poetry install --sync
      - name: Check formatting with black
        run: poetry run poe black --check
      - name: Type check with mypy
        run: poetry run poe mypy
      - name: Lint with ruff
        run: poetry run poe ruff

  dummy-required-job:
    runs-on: ubuntu-latest
    needs:
      - lint
      - test
      - coverage
      - build
      - lint-spec-parser
    if: always()
    steps:
      - run: exit 1
        if: ${{ contains( needs.*.result, 'failure' ) || contains( needs.*.result, 'cancelled' ) }}