SpacetimeDB/.github/workflows/docs-validate-nav-build.yml at edbf521fc72dedb6a8bf735722cb2a7725d6d234 · clockworklabs/SpacetimeDB · 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
name: Docs - Validate nav.ts

on:
  pull_request:
  push:
    branches:
      - master
  merge_group:

jobs:
  validate-build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - uses: pnpm/action-setup@v4
        with:
          run_install: true

      - name: Get pnpm store directory
        working-directory: sdks/typescript
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - uses: actions/cache@v4
        name: Setup pnpm cache
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Install dependencies
        working-directory: docs
        run: |
          pnpm install

      - name: Lint
        working-directory: docs
        run: |
          pnpm lint

      - name: Backup existing nav.js
        working-directory: docs
        run: |
          mv docs/nav.js docs/nav.js.original

      - name: Build nav.ts
        working-directory: docs
        run: |
          pnpm build

      - name: Compare generated nav.js with original nav.js
        working-directory: docs
        run: |
          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'pnpm build' and commit the updated file." && exit 1)

      # We do this after checking that nav.js matches nav.ts, to avoid confusing error messages if an author updates one but not the other.
      # If the .ts and .js are in sync, it doesn't matter which one we check against here.
      - name: Check that all files are listed in nav.js
        working-directory: docs
        run: |
          cp docs/nav.js docs/nav.mjs
          find docs -name '*.md' | sed 's!^docs/!!' > scripts/docs-files.txt
          node scripts/checkNav.mjs docs-files.txt

      - name: Restore original nav.js
        working-directory: docs
        if: success() || failure()
        run: |
          mv docs/nav.js.original docs/nav.js