v0.4.1 #221
Workflow file for this run
This file contains 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: mkdocs | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| ref: | |
| description: "The commit SHA, tag, or branch to publish. Uses the default branch if not specified." | |
| default: "" | |
| type: string | |
| release: | |
| types: [published] | |
| jobs: | |
| mkdocs: | |
| runs-on: ubuntu-latest | |
| env: | |
| CF_API_TOKEN_EXISTS: ${{ secrets.CF_API_TOKEN != '' }} | |
| MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ inputs.ref }} | |
| - uses: actions/setup-python@v5 | |
| - name: "Add SSH key" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| uses: webfactory/ssh-agent@v0.9.0 | |
| with: | |
| ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Install Insiders dependencies" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| run: pip install -r docs/requirements-insiders.txt | |
| - name: "Install dependencies" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | |
| run: pip install -r docs/requirements.txt | |
| - name: "Copy README File" | |
| run: | | |
| python scripts/transform_readme.py --target mkdocs | |
| python scripts/generate_mkdocs.py | |
| - name: "Build Insiders docs" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| run: mkdocs build --strict -f mkdocs.insiders.yml | |
| - name: "Build docs" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | |
| run: mkdocs build --strict -f mkdocs.public.yml | |
| - name: "Deploy to Cloudflare Pages" | |
| if: ${{ env.CF_API_TOKEN_EXISTS == 'true' }} | |
| uses: cloudflare/wrangler-action@v3.4.1 | |
| with: | |
| apiToken: ${{ secrets.CF_API_TOKEN }} | |
| accountId: ${{ secrets.CF_ACCOUNT_ID }} | |
| # `github.head_ref` is only set during pull requests and for manual runs or tags we use `main` to deploy to production | |
| command: pages deploy site --project-name=astral-docs --branch ${{ github.head_ref || 'main' }} --commit-hash ${GITHUB_SHA} |