OpenShell-Research/.github/workflows/docs-preview.yml at main · NVIDIA/OpenShell-Research · 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
name: Docs preview build

"on":
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - closed

permissions:
  contents: read
  pull-requests: read

concurrency:
  group: docs-preview-${{ github.event.pull_request.number }}
  cancel-in-progress: true

jobs:
  changes:
    name: Detect documentation changes
    runs-on: ubuntu-latest
    outputs:
      operation: ${{ steps.operation.outputs.operation }}
    steps:
      - name: Choose preview operation
        id: operation
        uses: actions/github-script@v8
        with:
          script: |
            if (context.payload.action === 'closed') {
              core.setOutput('operation', 'remove');
              return;
            }

            const files = await github.paginate(github.rest.pulls.listFiles, {
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: context.payload.pull_request.number,
              per_page: 100,
            });
            const exactInputs = new Set([
              '.github/workflows/docs.yml',
              '.github/workflows/docs-preview.yml',
              '.github/workflows/docs-preview-deploy.yml',
              'requirements-docs.txt',
              'scripts/build-docs.sh',
              'scripts/publish-agent-markdown.py',
              'scripts/render-dev-notes.py',
              'scripts/stage-egress-gate-docs.py',
              'tests/test_agent_markdown.py',
              'tests/test_docs_404.py',
              'tests/test_render_dev_notes.py',
              'tests/test_stage_egress_gate_docs.py',
              'zensical.toml',
            ]);
            const docsChanged = files.some(
              ({ filename }) => filename.startsWith('docs/') ||
                filename.startsWith('overrides/') ||
                filename.startsWith('projects/egress-gate/docs/') ||
                exactInputs.has(filename),
            );
            core.setOutput('operation', docsChanged ? 'deploy' : 'remove');

  build:
    name: Build documentation preview
    needs: changes
    if: needs.changes.outputs.operation == 'deploy'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: requirements-docs.txt

      - name: Build documentation
        run: scripts/build-docs.sh

      - name: Upload preview request
        uses: actions/upload-artifact@v7
        with:
          name: docs-preview-${{ github.event.pull_request.number }}-deploy
          path: site
          if-no-files-found: error
          retention-days: 1

  remove:
    name: Request preview removal
    needs: changes
    if: needs.changes.outputs.operation == 'remove'
    runs-on: ubuntu-latest
    steps:
      - name: Create removal request
        run: mkdir preview-removal && touch preview-removal/remove

      - name: Upload removal request
        uses: actions/upload-artifact@v7
        with:
          name: docs-preview-${{ github.event.pull_request.number }}-remove
          path: preview-removal
          if-no-files-found: error
          retention-days: 1