Merge pull request #1477 from emberjs/docs-generation-in-ci

Add Docs-Generation to CI -- will error if docs get out of sync and provides actionable information towards resolution.
emberjs · Aug 20, 2024 · c9f13a3 · c9f13a3
2 parents e131480 + 1906e42
commit c9f13a3
Show file tree

Hide file tree

Showing 4 changed files with 227 additions and 162 deletions.
diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml
@@ -50,6 +50,23 @@ jobs:
         working-directory: addon
         run: pnpm tsc --noEmit 
 
+  docs-gen:
+    timeout-minutes: 5
+    name: Docs Generation
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: pnpm
+      - name: Install Dependencies
+        run: pnpm install 
+      - run: pnpm build:docs
+      - run: echo "If this fails, docs gen is out of sync. Please run 'pnpm build:docs'" && git diff --exit-code
+
+
   floating:
     name: "Floating Dependencies"
     runs-on: ubuntu-latest