jumpstarter/.github/workflows/documentation.yaml at main · jumpstarter-dev/jumpstarter · 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
name: Documentation

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]
    paths:
      - 'python/docs/**'
      - 'python/packages/**'
      - 'protocol/proto/**'
  pull_request:
    paths:
      - 'python/docs/**'
      - 'python/packages/**'
      - 'protocol/proto/**'
  merge_group:

  # 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

defaults:
  run:
    shell: bash
    working-directory: python

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
        with:
          fetch-depth: 0
          fetch-tags: true

      - id: uv
        run: echo "version=$(cat .uv-version)" >> "$GITHUB_OUTPUT"
        working-directory: .
      - name: Install uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          version: ${{ steps.uv.outputs.version }}
          python-version-file: .py-version

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6

      - name: Build the python index
        run: |
          LATEST_RELEASE=$(gh release list --limit 1 --json tagName | jq -r .[0].tagName)
          uvx dumb-pypi \
            --package-list <(gh release view $LATEST_RELEASE --json assets | jq -r .assets[].name) \
            --packages-url https://github.com/jumpstarter-dev/jumpstarter/releases/download/$LATEST_RELEASE \
            --title "Jumpstarter Python Packages" --output-dir docs/source/extra/packages
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Build the documentation
        run: make docs-all

      - name: Upload artifact
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
        with:
          path: ./python/docs/build

  check-warnings:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
        with:
          fetch-depth: 0
          fetch-tags: true

      - id: uv
        run: echo "version=$(cat .uv-version)" >> "$GITHUB_OUTPUT"
        working-directory: .
      - name: Install uv
        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          version: ${{ steps.uv.outputs.version }}
          python-version-file: .py-version

      - name: Verify generated gRPC docs are up to date
        run: make docs-check-grpc

      - name: Build the documentation for the current version (no warnings allowed)
        run: make sync && make docs

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5