Skip to content

release-docs

release-docs #45

Workflow file for this run

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@v4
if: github.event_name == 'repository_dispatch'
with:
ref: ${{ github.event.client_payload.ref }}
- name: Checkout Pex (for manual workflow dispatch)
uses: actions/checkout@v4
if: github.event_name == 'workflow_dispatch'
- name: Setup Python 3.11
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Build Doc Site
uses: pantsbuild/actions/run-tox@b16b9cf47cd566acfe217b1dafc5b452e27e6fd7
with:
tox-env: docs -- --linkcheck --pdf --clean-html
- 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