change to rsync #37
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: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [opened, reopened, synchronize] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| env: | |
| PYTHON_VRSN: '3.12' | |
| VENV_PATH: '.venv' | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Setup uv with Python ${{ env.PYTHON_VRSN }} | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: ${{ env.PYTHON_VRSN }} | |
| - name: Cache uv venv | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ env.VENV_PATH }} | |
| key: ${{ runner.os }}-uv-${{ env.PYTHON_VRSN }}-${{ hashFiles('pyproject.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-uv-${{ env.PYTHON_VRSN }}- | |
| - name: Install dependencies | |
| run: uv sync | |
| - name: Lint Sphinx docs | |
| run: uv run sphinx-lint source | |
| - name: Build HTML docs | |
| run: uv run make clean html | |
| - name: Minimize uv cache | |
| run: uv cache prune --ci | |
| # -- Deploy to GitHub Pages only on push to upstream main | |
| - name: Setup GitHub Pages | |
| if: ${{ github.ref_name == 'main' && (github.event_name == 'push' || github.event_name == 'merge_group') }} | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact to GitHub Pages | |
| if: ${{ github.ref_name == 'main' && (github.event_name == 'push' || github.event_name == 'merge_group') }} | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| name: github-pages | |
| path: build/html | |
| retention-days: 1 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| if: ${{ github.ref_name == 'main' && (github.event_name == 'push' || github.event_name == 'merge_group') }} | |
| uses: actions/deploy-pages@v4 |