chore: add docs to ci

Juveniel · Juveniel · commit b3fb2b3b83fe · 2025-08-25T10:04:04.000+03:00
diff --git a/.github/workflows/_docs-check.yml b/.github/workflows/_docs-check.yml
@@ -0,0 +1,49 @@
+name: CI | Docs
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+concurrency:
+  group: docs-check-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  docs-verify:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Use cache for root node_modules
+        id: cache-root-node_modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: root-node_modules-${{ steps.setup-node.outputs.node-version }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install
+        if: steps.cache-root-node_modules.outputs.cache-hit != 'true'
+        run: |
+          npm ci --no-audit --no-fund
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: .tmp
+
+      - name: Unpack artifacts
+        run: find .tmp -name "*.tar" -type f -exec tar -xf {} \;
+
+      - name: Check docs
+        run: npm run docs:check
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -153,3 +153,16 @@ jobs:
     steps:
       - name: Done
         run: echo "Done!"
+
+  docs:
+    name: Docs
+    needs: [ compile-themes ]
+    uses: ./.github/workflows/_docs-check.yml
+
+  ci-docs:
+    name: Status check > Docs
+    runs-on: ubuntu-latest
+    needs: [ docs ]
+    steps:
+      - name: Done
+        run: echo "Done!"
diff --git a/build/mark-checks.sh b/build/mark-checks.sh
@@ -18,6 +18,7 @@ declare -a checks=( \
   'Status check > A11y' \
   'Status check > Integration' \
   'Status check > Unit' \
+  'Status check > Docs' \
   'Status check > HTML spec' \
 )
 
diff --git a/nx.json b/nx.json
@@ -33,6 +33,13 @@
     },
     "docs": {
       "cache": true
+    },
+    "docs:check": {
+      "cache": false,
+      "executor": "nx:run-script",
+      "options": {
+        "script": "docs:check"
+      }
     }
   }
 }
diff --git a/package.json b/package.json
@@ -61,7 +61,7 @@
     "sass": "nx run-many -t sass",
     "sass:dist": "nx run-many -t sass:dist",
     "docs": "nx run-many -t docs",
-    "docs:check": "npm run docs -- git diff --exit-code -- docs/",
+    "docs:check": "nx run-many -t docs:check",
     "test:render-test-pages": "node ./scripts/render-test-pages.mjs",
     "test:contrast": "node ./scripts/test-contrast.mjs",
     "test:create-screenshots": "./build/create-screenshots.sh",
diff --git a/packages/bootstrap/package.json b/packages/bootstrap/package.json
@@ -44,6 +44,7 @@
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "css:prefix": "npx postcss --replace ./dist/**/*.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (bootstrap). Run npm run sass && npm run docs' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/classic/package.json b/packages/classic/package.json
@@ -44,6 +44,7 @@
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "css:prefix": "npx postcss --replace ./dist/**/*.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (classic).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -35,6 +35,7 @@
     "sass:compile:dist": "npx sass --style=compressed --no-source-map --load-path=../../node_modules ./dist:dist",
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (core).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/default/package.json b/packages/default/package.json
@@ -43,6 +43,7 @@
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "css:prefix": "npx postcss --replace ./dist/**/*.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (default).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/fluent/package.json b/packages/fluent/package.json
@@ -45,6 +45,7 @@
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "css:prefix": "npx postcss --replace ./dist/**/*.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (fluent).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/material/package.json b/packages/material/package.json
@@ -45,6 +45,7 @@
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "css:prefix": "npx postcss --replace ./dist/**/*.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (material).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -36,6 +36,7 @@
     "sass:compile:dist": "npx sass --style=compressed --no-source-map --load-path=../../node_modules ./dist:dist",
     "sass:watch": "npx sass --no-source-map --load-path=../../node_modules --watch ./scss/all.scss ./dist/all.css",
     "docs": "node ../../scripts/sassdoc.js",
+    "docs:check": "npm run docs && git diff --name-only --exit-code -- docs || (echo 'Docs out of date (utils).' && exit 1)",
     "predocs": "npm run resolve-variables",
     "resolve-variables": "node ../../scripts/resolve-variables.js",
     "nuget-pack": "jq '.version' package.json | xargs nuget pack package.nuspec -Version",

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ declare -a checks=( \`
`18`	`18`	`'Status check > A11y' \`
`19`	`19`	`'Status check > Integration' \`
`20`	`20`	`'Status check > Unit' \`
	`21`	`+ 'Status check > Docs' \`
`21`	`22`	`'Status check > HTML spec' \`
`22`	`23`	`)`
`23`	`24`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,13 @@`
`33`	`33`	`},`
`34`	`34`	`"docs": {`
`35`	`35`	`"cache": true`
	`36`	`+ },`
	`37`	`+ "docs:check": {`
	`38`	`+ "cache": false,`
	`39`	`+ "executor": "nx:run-script",`
	`40`	`+ "options": {`
	`41`	`+ "script": "docs:check"`
	`42`	`+ }`
`36`	`43`	`}`
`37`	`44`	`}`
`38`	`45`	`}`