check_docstring_coverage.yml

# A check to ensure that our docstring coverage remains pretty good.
#
# We use interrogate (https://interrogate.readthedocs.io/) to check
# docstring coverage.  Settings are under `[tool.interrogate]` section
# of the pyproject.toml file in the top-level directory.

name: Check docstring coverage

on:
  push:
    branches:
      - "main"
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

jobs:

  checks:
    runs-on: ubuntu-latest

    steps:
      - name: Check out sources
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.x"
          cache: 'pip'  # cache pip dependencies
          cache-dependency-path: pyproject.toml

      - name: Install interrogate
        run: |
          python -m pip install --upgrade pip
          python -m pip install interrogate==1.7.0

      - name: Check docstring coverage with interrogate
        run: |
          python -m interrogate -vv fabrictestbed_extensions