continuous-integration.yml

name: Continuous Integration

on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

defaults:
  run:
    shell: bash

permissions:
  contents: read

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
      fail-fast: false
    steps:

      - name: Harden Runner
        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
        with:
          egress-policy: audit

      - name: Check out the commit
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

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

      - name: Install development dependencies
        run: |
          python3 -m pip install --upgrade pip
          python3 -m pip install \
            -r requirements.txt \
            -r doc/requirements.txt \
            -r test/requirements.txt

      - name: Test install
        run: python3 -m pip install .

      - name: Test with pytest
        run: python3 -m pytest --cov=staged_script example/ test/

      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@b9fd7d16f6d7d1b5d2bec1a2887e65ceed900238 # v4.6.0
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

      - name: Check documentation spelling
        run: make spelling
        working-directory: ./doc

      - name: Check documentation coverage
        run: |
          make coverage
          mv build/coverage/python.txt ../docs-coverage-report-${{ matrix.version }}.txt
        working-directory: ./doc

      - name: Archive documentation coverage results
        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
        with:
          name: docs-coverage-report-${{ matrix.version }}
          path: docs-coverage-report-${{ matrix.version }}.txt

      - name: Test uninstall
        run: python3 -m pip uninstall -y reverse_argparse

  commits:
    runs-on: ubuntu-latest
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
        with:
          egress-policy: audit

      - name: Conventional Commits
        uses: taskmedia/action-conventional-commits@cb0de258e7309e163ee353a8c38e24e609608cd6 # v1.1.19
        with:
          types: >
            build|chore|ci|docs|feat|fix|minor|patch|perf|style|refactor|test