also looking at this
feat(ci): check the docs against the source they describe
#1403
3 files
+311
-1
| @@ -84,8 +84,34 @@ jobs: | ||
| 84 | 84 | - name: Unit Test |
| 85 | 85 | run: bun test --timeout 300000 |
| 86 | 86 | |
| 87 | check-docs: | |
| 88 | runs-on: ubuntu-latest | |
| 89 | ||
| 90 | steps: | |
| 91 | - uses: actions/checkout@v6 | |
| 92 | ||
| 93 | - name: Install Bun | |
| 94 | uses: oven-sh/setup-bun@v2.2.0 | |
| 95 | ||
| 96 | - name: Use cached node_modules | |
| 97 | uses: actions/cache@v5.0.4 | |
| 98 | with: | |
| 99 | path: node_modules | |
| 100 | key: node-modules-${{ hashFiles('**/bun.lock') }} | |
| 101 | restore-keys: | | |
| 102 | node-modules- | |
| 103 | ||
| 104 | - name: Install Dependencies | |
| 105 | run: bun install | |
| 106 | ||
| 107 | # Deliberately part of CI rather than the Docs workflow: that one is | |
| 108 | # path-filtered on `docs/`, so a change under `src/` that invalidates a | |
| 109 | # documented flag would never re-check the pages describing it. | |
| 110 | - name: Check docs against source | |
| 111 | run: bun run check:docs | |
| 112 | ||
| 87 | 113 | publish-commit: |
| 88 | needs: [lint, typecheck, test] | |
| 114 | needs: [lint, typecheck, test, check-docs] | |
| 89 | 115 | runs-on: ubuntu-latest |
| 90 | 116 | |
| 91 | 117 | steps: |