fix: bind allowlisted extensions to discovered sources (#362) #260
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "README.md" | |
| - "SECURITY.md" | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "pyproject.toml" | |
| - "scripts/validate_docs.py" | |
| - "scripts/validate_changelog.py" | |
| - "scripts/generate_compatibility_dashboard.py" | |
| - ".github/workflows/tests.yml" | |
| - ".github/workflows/dependency-matrix.yml" | |
| - ".github/workflows/compatibility.yml" | |
| - "scripts/generate_api_reference.py" | |
| - "scripts/generate_compatibility_dashboard.py" | |
| - ".github/workflows/tests.yml" | |
| - ".github/workflows/dependency-matrix.yml" | |
| - ".github/workflows/compatibility.yml" | |
| - "tests/validate.sh" | |
| - "tests/full_validate.sh" | |
| - "docs/testing.md" | |
| - ".github/workflows/docs.yml" | |
| pull_request: | |
| paths: | |
| - "README.md" | |
| - "SECURITY.md" | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "pyproject.toml" | |
| - "scripts/validate_docs.py" | |
| - "scripts/generate_api_reference.py" | |
| - "tests/validate.sh" | |
| - "tests/full_validate.sh" | |
| - "docs/testing.md" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Build and validate documentation | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Check out source | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 | |
| with: | |
| python-version: "3.13" | |
| - name: Install documentation tools | |
| run: python -m pip install ".[docs]" | |
| - name: Validate repository links and examples | |
| run: | | |
| python scripts/validate_docs.py | |
| python scripts/validate_changelog.py | |
| python scripts/generate_compatibility_dashboard.py --check | |
| - name: Validate generated public API reference | |
| run: python scripts/generate_api_reference.py --check | |
| - name: Build documentation with strict warnings | |
| run: python -m mkdocs build --strict --site-dir site | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0 | |
| with: | |
| path: site | |
| deploy: | |
| name: Deploy documentation site | |
| if: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main' }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@f33f41b675f0ab2dc5a6863c9a170fe83af3571e # v4.0.0 |