static.yaml

name: Static code checks

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  static_checks:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

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

    - name: Log system information
      run: |
        test -r /etc/os-release && sh -c '. /etc/os-release && echo "OS: $PRETTY_NAME"'
        python --version
        python -c "print('\nENVIRONMENT VARIABLES\n=====================\n')"
        python -c "import os; [print(f'{k}={v}') for k, v in os.environ.items()]"

    - name: Run mypy
      run: |
        tox -e mypy

    - name: Run pyflakes
      run: |
        tox -e pyflakes

    - name: Run pydoctor on its own source and fail on docstring errors
      run: |
        tox -e apidocs

    - name: Run docs and check extensions
      run: |
        tox -e testdocs