wiki/.github/workflows/preview.yml at main · psf/wiki · 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
name: PR Preview

on:
  pull_request:
    types: [opened, synchronize, reopened, closed]

permissions:
  contents: write
  pull-requests: write

concurrency:
  group: preview-${{ github.ref }}
  cancel-in-progress: true

jobs:
  preview:
    name: Build & Deploy Preview
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          fetch-depth: 0

      - name: Restore file timestamps
        if: github.event.action != 'closed'
        uses: chetan/git-restore-mtime-action@d186aca54f8760da4dec55313195e51ed3ebb0b3 # v2.3

      - name: Detect changed sections
        if: github.event.action != 'closed'
        id: detect
        run: |
          changed=$(git diff --name-only origin/main...HEAD)

          # Global files that require a full build
          if echo "$changed" | grep -qE '^(conf\.py|index\.md|_templates/|_static/|_redirects_html/)'; then
            echo "wiki=" >> $GITHUB_OUTPUT
            echo "Full build required (global files changed)"
            exit 0
          fi

          # Count which wiki sections have changes
          wikis=""
          for w in python psf jython; do
            if echo "$changed" | grep -q "^${w}/"; then
              wikis="$wikis $w"
            fi
          done

          # If exactly one section changed, scope to it
          count=$(echo $wikis | wc -w | tr -d ' ')
          if [ "$count" = "1" ]; then
            wiki=$(echo $wikis | tr -d ' ')
            echo "wiki=$wiki" >> $GITHUB_OUTPUT
            echo "Scoped build: WIKI=$wiki"
          else
            echo "wiki=" >> $GITHUB_OUTPUT
            echo "Full build (${count} sections changed)"
          fi

      - name: Set up uv
        if: github.event.action != 'closed'
        uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
        with:
          enable-cache: true

      - name: Set up Python
        if: github.event.action != 'closed'
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: "3.14"

      - name: Install dependencies
        if: github.event.action != 'closed'
        run: uv sync

      - name: Restore Sphinx build cache
        if: github.event.action != 'closed'
        uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
        with:
          path: _build/html
          key: sphinx-build-preview-${{ github.event.pull_request.head.sha }}
          restore-keys: |
            sphinx-build-preview-
            sphinx-build-

      - name: Build Sphinx site
        if: github.event.action != 'closed'
        env:
          WIKI: ${{ steps.detect.outputs.wiki }}
        run: uv run sphinx-build -b html . _build/html -j auto --keep-going

      - name: Deploy preview
        uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1
        with:
          source-dir: _build/html/