Check docs workflow (ddev/ddev)

name: Check docs
defaults:
  run:
    shell: bash
 
on:
  push:
    branches: [ main ]
  pull_request:
    paths:
      - "docs/**"
      - ".spellcheckwordlist.txt"
      - ".spellcheck.yml"
      - ".markdownlint.jsonc"
      - "mkdocs.yml"
      - ".readthedocs.yaml"
      - ".github/workflows/**"
      - ".linkspector.yml"
 
  workflow_dispatch:
    inputs:
      debug_enabled:
        description: 'Run the build with tmate set "debug_enabled"'
        type: boolean
        required: false
        default: false
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
permissions:
  actions: write
 
jobs:
  build:
    timeout-minutes: 30
    name: Docs check (spellcheck, links, markdownlint, textlint)
    # linkspector seems to fail with "No usable sandbox"
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
 
      - name: Spellcheck
        uses: rojopolis/spellcheck-github-actions@v0
      - name: Install textlint
        run: |
          npm init -y
          npm install textlint textlint-filter-rule-comments textlint-rule-no-todo textlint-rule-stop-words textlint-rule-terminology
      - name: Run textlint
        uses: tsuyoshicho/action-textlint@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-check
          textlint_flags: "{README.md,version-history.md,docs/**}"
      - name: Setup tmate session
        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
        uses: mxschmitt/action-tmate@v3
        with:
          limit-access-to-actor: true
      - name: Run linkspector to check external links
        uses: umbrelladocs/action-linkspector@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-check
          fail_on_error: true
          # Check links only in the added lines for PRs, but check everything otherwise
          filter_mode: ${{ github.event_name == 'pull_request' && 'added' || 'nofilter' }}
          config_file: '.linkspector.yml'
      - name: Run markdownlint
        run: |
          npm install -g markdownlint-cli
          make markdownlint
      - name: Test zensical
        run: |
          pip install -r docs/requirements.txt
          zensical build --clean --strict