Add checks for broken docs urls #1
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: check-doc-links | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.id || github.ref }} | |
| cancel-in-progress: true | |
| on: | |
| pull_request: | |
| branches: ["main"] | |
| paths: | |
| - "docs/**/*.md" | |
| - "docs/app/scripts/check_doc_links.py" | |
| - ".github/workflows/check_doc_links.yml" | |
| push: | |
| branches: ["main"] | |
| paths: | |
| - "docs/**/*.md" | |
| - "docs/app/scripts/check_doc_links.py" | |
| - ".github/workflows/check_doc_links.yml" | |
| jobs: | |
| check-doc-links: | |
| timeout-minutes: 20 | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: docs/app | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: ./.github/actions/setup_build_env | |
| with: | |
| python-version: 3.14 | |
| run-uv-sync: true | |
| - name: Build frontend to generate sitemap.xml | |
| run: uv run reflex export --frontend-only --no-zip | |
| - name: Validate /docs links against sitemap.xml | |
| run: uv run python scripts/check_doc_links.py |