validate_links.yaml

name: Check Markdown links

on:
  push:
    branches:
      - main
      - 3.x.x
    paths:
      - "**.md"
  pull_request:
    branches: [main, 3.x.x]
    types: [opened, synchronize]
    paths:
      - "**.md"
  schedule:
    # Run everyday at 9:00 AM
    - cron: "0 9 * * *"

jobs:
  build-docs-to-validate-links:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/setup-python-uv
      - run: |
          OUTPUT=$(uv run mkdocs build 2>&1)
          echo "$OUTPUT"

          if echo "$OUTPUT" | grep -q "ERROR"; then
              exit 1
          fi

  markdown-link-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          use-quiet-mode: "yes"
          use-verbose-mode: "yes"
          folder-path: "."