Repository navigation
Bump actions/checkout from 6 to 7 #54
Workflow file for this run
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: Docs | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| name: Build docs | |
| runs-on: ubuntu-latest | |
| env: | |
| DOCS_SSH_PRIVATE_KEY: ${{ secrets.DOCS_SSH_PRIVATE_KEY }} | |
| DOCS_SSH_USER: ${{ secrets.DOCS_SSH_USER }} | |
| DOCS_SSH_HOST: ${{ secrets.DOCS_SSH_HOST }} | |
| DOCS_SSH_PATH: ${{ secrets.DOCS_SSH_PATH }} | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version-file: ".python-version" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| version: "0.9.24" | |
| - name: Build docs | |
| run: | | |
| set -e | |
| uv run make -C docs html | |
| - name: Deploy docs via SSH | |
| if: >- | |
| github.event_name == 'push' && | |
| github.ref == 'refs/heads/main' && | |
| env.DOCS_SSH_PRIVATE_KEY != '' && | |
| env.DOCS_SSH_USER != '' && | |
| env.DOCS_SSH_HOST != '' && | |
| env.DOCS_SSH_PATH != '' | |
| uses: webfactory/ssh-agent@v0.10.0 | |
| with: | |
| ssh-private-key: ${{ env.DOCS_SSH_PRIVATE_KEY }} | |
| - name: Disable strict host key checking | |
| if: >- | |
| github.event_name == 'push' && | |
| github.ref == 'refs/heads/main' && | |
| env.DOCS_SSH_PRIVATE_KEY != '' && | |
| env.DOCS_SSH_USER != '' && | |
| env.DOCS_SSH_HOST != '' && | |
| env.DOCS_SSH_PATH != '' | |
| run: | | |
| mkdir -p ~/.ssh | |
| echo "StrictHostKeyChecking no" >> ~/.ssh/config | |
| - if: >- | |
| github.event_name == 'push' && | |
| github.ref == 'refs/heads/main' && | |
| env.DOCS_SSH_PRIVATE_KEY != '' && | |
| env.DOCS_SSH_USER != '' && | |
| env.DOCS_SSH_HOST != '' && | |
| env.DOCS_SSH_PATH != '' | |
| run: | | |
| rsync -avz --delete site/ ${{ env.DOCS_SSH_USER }}@${{ env.DOCS_SSH_HOST }}:${{ env.DOCS_SSH_PATH }} |