check-pr.yml

# This workflow runs the pre-commit hooks on all files and confirms the docs can be built.
#
# Author: Stefanie Molin

name: Check PR

on:
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  # Run pre-commit checks on all files
  linting:
    runs-on: ubuntu-latest
    name: Lint
    steps:
      - name: Checkout Code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
        with:
          python-version: "3.x"

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install pre-commit
          pre-commit install

      - name: Run Checks
        run: |
          pre-commit run --all-files --show-diff-on-failure

  # Check that docs can be built
  docs:
    runs-on: ubuntu-latest
    name: Build docs

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
        with:
          fetch-depth: 0

      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
        with:
          python-version: "3.x"

      - name: Install dependencies
        run: |
          python -m pip install '.[docs]'

      - name: Sphinx build
        run: |
          cd docs
          make html