release-docs #231
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: Deploy Doc Site | |
| on: | |
| repository_dispatch: | |
| types: [release-docs] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout Pex (for release-docs event) | |
| uses: actions/checkout@v6 | |
| if: github.event_name == 'repository_dispatch' | |
| with: | |
| ref: ${{ github.event.client_payload.ref }} | |
| - name: Checkout Pex (for manual workflow dispatch) | |
| uses: actions/checkout@v6 | |
| if: github.event_name == 'workflow_dispatch' | |
| - name: Setup Python 3.11 | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.11" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| - name: Build Doc Site | |
| if: github.repository_owner == 'pex-tool' | |
| run: uv run dev-cmd docs -- --linkcheck --pdf --clean-html | |
| - name: Build Fork Doc Site | |
| if: github.repository_owner != 'pex-tool' | |
| run: uv run dev-cmd docs -- --linkcheck --pdf --clean-html --subdir ${{ github.event.repository.name }} | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "dist/docs/html/" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |