@@ -13,6 +13,7 @@ The project includes several specialized CI workflows that handle specific opera
1313
1414- ** 🐳 Docker CI** - Container image building and testing
1515- ** 📋 DockerHub README CI** - Repository description synchronization
16+ - ** 📚 Documentation Build Check** - Validates documentation builds on PRs and branch changes
1617- ** 🤖 Documentation Auto-Approve & Auto-Merge** - Streamlined docs updates
1718
1819---
@@ -58,6 +59,52 @@ The `dockerhub-readme-ci.yml` workflow updates the Docker Hub repository descrip
5859
5960---
6061
62+ ## Documentation Build Check
63+
64+ [ ![ Documentation Build Check] ( https://github.com/Chisanan232/slack-mcp-server/actions/workflows/docs-build-check.yaml/badge.svg )] ( https://github.com/Chisanan232/slack-mcp-server/actions/workflows/docs-build-check.yaml )
65+
66+ The [ ` docs-build-check.yaml ` ] ( https://github.com/Chisanan232/slack-mcp-server/blob/master/.github/workflows/docs-build-check.yaml ) workflow validates that documentation builds successfully whenever documentation-related files are modified.
67+
68+ ** Triggers:**
69+ - ** Pull Requests** : Any PR that modifies documentation files
70+ - ** Push Events** : All branches except ` master ` (to avoid conflicts with the main documentation deployment workflow)
71+ - ** Path Monitoring** : Automatically detects changes to documentation content, configuration, and dependencies
72+
73+ ** Purpose** : Ensures documentation builds successfully before merging changes, preventing broken documentation deployments.
74+
75+ ** Key Features:**
76+ - ** Comprehensive Path Monitoring** - Watches all documentation-related files including content, configuration, dependencies, and assets
77+ - ** Fast Build Validation** - Uses optimized setup with shallow clones and dependency caching for quick feedback
78+ - ** Build Quality Checks** - Validates build output, critical files, and provides detailed build statistics
79+ - ** TypeScript Validation** - Runs type checking to catch configuration errors early
80+ - ** Concurrency Control** - Cancels in-progress runs for the same PR/branch to save resources
81+ - ** Detailed Reporting** - Provides comprehensive build summaries in GitHub Actions interface
82+
83+ ** Build Process:**
84+ 1 . ** Environment Setup** : Node.js 22 + pnpm 10 (matching production deployment)
85+ 2 . ** Dependency Installation** : Uses frozen lockfile for consistency
86+ 3 . ** Type Checking** : Validates TypeScript configuration and content
87+ 4 . ** Documentation Build** : Executes full Docusaurus build process
88+ 5 . ** Quality Validation** : Checks build artifacts and critical files
89+ 6 . ** Build Reporting** : Provides detailed statistics and status summary
90+
91+ ** Path Coverage:**
92+ - CI workflow configurations (` .github/workflows/docs-build-check.yaml ` , ` documentation.yaml ` )
93+ - Dependencies (` package.json ` , ` pnpm-lock.yaml ` )
94+ - Configuration files (` docusaurus.config.ts ` , ` tsconfig.json ` )
95+ - Content files (` .md ` , ` .mdx ` , ` .ts ` , ` .tsx ` , ` .js ` , ` .jsx ` , ` .css ` )
96+ - Versioned content and sidebars
97+ - Static assets and source files
98+
99+ ** Safety Mechanisms:**
100+ - Prevents conflicts with main documentation deployment workflow
101+ - Uses frozen lockfile installation for reproducible builds
102+ - Validates critical files existence (index.html, 404.html)
103+ - Provides warnings for potential build issues
104+ - Includes comprehensive error reporting and debugging information
105+
106+ ---
107+
61108## Documentation Auto-Approve & Auto-Merge
62109
63110[ ![ Docs-only auto-approve & automerge] ( https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/docs-automerge.yml/badge.svg )] ( https://github.com/Chisanan232/Template-Python-UV-Project/actions/workflows/docs-automerge.yml )
@@ -88,9 +135,9 @@ The `docs-automerge.yml` workflow automatically approves and merges pull request
88135These additional CI workflows integrate with the main CI/CD system:
89136
90137### ** Integration Points:**
91- - ** API Spec Checking** → Feeds into development planning and feature updates
92138- ** Docker CI** → Validates containers before release workflows
93139- ** DockerHub README** → Ensures registry documentation stays current
140+ - ** Documentation Build Check** → Validates docs builds on PRs to prevent broken deployments
94141- ** Docs Auto-merge** → Accelerates documentation maintenance
95142
96143### ** Monitoring and Maintenance:**
0 commit comments