stellar-dev-dashboard/.github/workflows/docs.yml at master · Nanle-code/stellar-dev-dashboard · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
name: Deploy API Documentation

on:
  push:
    branches:
      - master
    paths:
      - 'docs/**'
      - 'docs-site/**'
      - 'src/lib/**'
  pull_request:
    branches:
      - master
    paths:
      - 'docs/**'
      - 'docs-site/**'
      - 'src/lib/**'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # ─────────────────────────────────────────────
  # Regenerate the auto-generated API reference
  # ─────────────────────────────────────────────
  generate-api-docs:
    name: Generate API Reference
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install root dependencies
        run: npm ci

      - name: Regenerate API reference from JSDoc
        run: npm run docs:api:generate

      - name: Upload generated docs
        uses: actions/upload-artifact@v7
        with:
          name: generated-api-docs
          path: docs/api/generated/
          retention-days: 1

  # ─────────────────────────────────────────────
  # Detect documentation drift (broken paths,
  # scripts, commands, and links)
  # ─────────────────────────────────────────────
  validate-docs-drift:
    name: Validate Docs Drift
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install root dependencies
        run: npm ci

      - name: Validate documentation drift
        run: npm run docs:validate-drift

  # ─────────────────────────────────────────────
  # Validate example scripts run without errors
  # ─────────────────────────────────────────────
  validate-examples:
    name: Validate Example Scripts
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install root dependencies
        run: npm ci

      - name: Check JS examples syntax
        run: |
          for f in docs/api/examples/js/*.mjs docs/api/examples/js/*.js; do
            echo "Checking: $f"
            node --check "$f"
          done

      - name: Setup Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.11'

      - name: Check Python examples syntax
        run: |
          for f in docs/api/examples/python/*.py; do
            echo "Checking: $f"
            python -m py_compile "$f"
          done

  # ─────────────────────────────────────────────
  # Build Docusaurus site
  # ─────────────────────────────────────────────
  build-docs-site:
    name: Build Docusaurus
    runs-on: ubuntu-latest
    needs: [generate-api-docs]
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Download generated docs
        uses: actions/download-artifact@v8
        with:
          name: generated-api-docs
          path: docs/api/generated/

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '20'
          cache: 'npm'
          cache-dependency-path: docs-site/package.json

      - name: Install Docusaurus dependencies
        run: npm ci
        working-directory: docs-site

      - name: Build Docusaurus site
        run: npm run build
        working-directory: docs-site
        env:
          NODE_ENV: production

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs-site/build/

  # ─────────────────────────────────────────────
  # Deploy to GitHub Pages (master branch only)
  # ─────────────────────────────────────────────
  deploy-docs:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    needs: build-docs-site
    if: github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5