pyprefab/.github/workflows/publish-docs.yaml at 8c19ef540d1384c085a63fbfae105d97ac81bee1 · bsweger/pyprefab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# .github/workflows/publish-docs.yaml
# publish sphinx docs to github pages
name: Publish docs to GitHub Pages

on:
  push:
    tags:
      # only run workflow for tags in release format
      - "v[0-9]+.[0-9]+.[0-9]+"
  workflow_dispatch:

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

jobs:
  build-docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Install uv 🌟
        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 #v7.6.0
        with:
          version: "0.9.16"

      - name: Build Sphinx docs 🗿
        shell: bash
        run: |
          uv run --group docs sphinx-build docs/source docs/_build/html --fresh-env --fail-on-warning

      - name: Upload artifact 📤
        uses: actions/upload-pages-artifact@v5
        with:
          name: static-docs
          path: docs/_build/html

  deploy-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build-docs

    steps:
      - name: Deploy to GitHub pages 🚀
        id: deployment
        uses: actions/deploy-pages@v5
        with:
          artifact_name: static-docs
          token: ${{ github.token }}