Merge pull request #454 from PingoLee/fix/414-415-pg-introspection #371
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: | |
| # Builds the docs and, on a push to main, deploys /dev. Release tags are handled | |
| # by DocumentationRelease.yml — a push trigger's paths filter applies to tags too, | |
| # so tags can't be exempted within this same block. | |
| push: | |
| branches: | |
| - main | |
| # Only rebuild when something that affects the docs changes. `src/**` is included | |
| # so docstring edits rebuild the site and checkdocs = :exports catches breakage. | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - 'src/**' | |
| pull_request: | |
| # Same filter for Pull Requests (build-only; no deploy). | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - 'src/**' | |
| jobs: | |
| build: | |
| permissions: | |
| contents: write | |
| pages: write | |
| statuses: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| # checkout must precede the local composite action so it is on disk. | |
| - uses: actions/checkout@v4 | |
| - uses: ./.github/actions/build-docs | |
| with: | |
| # Deploy /dev only on a push to main; PRs build without secrets. | |
| deploy: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| documenter-key: ${{ secrets.DOCUMENTER_KEY }} |