docs-lint.yml

name: Docs Lint

on:
  pull_request:
  push:
    branches: [ main ]

jobs:
  docs-lint:
    name: Documentation Structure & Scaladoc
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up ripgrep
        run: |
          sudo apt-get update
          sudo apt-get install -y ripgrep

      - name: Run docs structure lint
        run: bash scripts/lint-docs.sh

      - name: Run Scaladoc coverage check
        run: |
          chmod +x scripts/doclint.sh
          ./scripts/doclint.sh | tee doclint-report.txt

      - name: Upload Scaladoc report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: doclint-report
          path: doclint-report.txt
          retention-days: 7