# Sample workflow for building and deploying a Hugo site to GitHub Pages name: Deploy mkdocs site to Pages on: # Runs on pushes targeting the default branch push: branches: - main # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: contents: read pages: write id-token: write # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. concurrency: group: "pages" cancel-in-progress: false # Default to bash defaults: run: shell: bash jobs: # Build job build: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: submodules: recursive fetch-depth: 0 sparse-checkout: | docs/ pyproject.toml uv.lock - name: Setup Pages id: pages uses: actions/configure-pages@v5 - name: Install uv uses: astral-sh/setup-uv@v6 with: enable-cache: true cache-dependency-glob: "uv.lock" activate-environment: true - name: Install dependencies run: uv sync --frozen --only-group docs - name: Build docs working-directory: docs run: | uv run mkdocs build --strict env: MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }} ENABLE_GIT_PLUGINS: true - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: path: ./docs/site/ # Deployment job deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest needs: build steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4