linting.yml

name: Linting
on:
  pull_request:

jobs:
  prose:
    runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
          cache: 'pip'

      - name: Install Python dependencies
        run: pip3 install -r docs/requirements.txt

      - name: Vale
        uses: errata-ai/vale-action@reviewdog
        with:
          # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
          version: 3.7.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
          cache: 'pip'

      - name: Install Python dependencies
        run: pip3 install -r docs/requirements.txt
    
      - name: Build docs
        working-directory: docs
        run: make html

      - name: Check links
        working-directory: docs
        run: make checklinks

  doctor_rst:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # Ensures full history is fetched

      - name: "Create cache dir"
        run: mkdir .cache

      - name: "Extract base branch name"
        run: echo "branch=$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})" >> $GITHUB_OUTPUT
        id: extract_base_branch

      - name: "Cache DOCtor-RST"
        uses: actions/cache@v3
        with:
          path: .cache
          key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}

      - name: "Run DOCtor-RST"
        uses: docker://oskarstark/doctor-rst:1.61.1
        with:
          args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache
        env:
            DOCS_DIR: 'docs/'