aitbc1
d609625248
- Markdown linting with markdownlint - Broken link checking - YAML frontmatter validation - Documentation structure checks - Generate documentation statistics
105 lines
3.2 KiB
YAML
105 lines
3.2 KiB
YAML
name: Documentation Validation
|
|
|
|
on:
|
|
push:
|
|
branches: [ main, develop ]
|
|
paths:
|
|
- 'docs/**'
|
|
- '**/*.md'
|
|
- '.gitea/workflows/docs-validation.yml'
|
|
pull_request:
|
|
branches: [ main, develop ]
|
|
paths:
|
|
- 'docs/**'
|
|
- '**/*.md'
|
|
- '.gitea/workflows/docs-validation.yml'
|
|
workflow_dispatch:
|
|
|
|
# Prevent parallel execution
|
|
concurrency:
|
|
group: docs-validation-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
validate-docs:
|
|
runs-on: debian
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '20'
|
|
|
|
- name: Install markdown validation tools
|
|
run: |
|
|
echo "=== INSTALLING MARKDOWN TOOLS ==="
|
|
npm install -g markdownlint-cli@0.41.0
|
|
npm install -g markdown-link-check@3.12.2
|
|
echo "✅ Markdown tools installed"
|
|
|
|
- name: Lint Markdown files
|
|
run: |
|
|
echo "=== LINTING MARKDOWN FILES ==="
|
|
markdownlint "docs/**/*.md" "*.md" --ignore "docs/archive/**" --ignore "node_modules/**" || {
|
|
echo "⚠️ Markdown linting completed with warnings"
|
|
exit 0
|
|
}
|
|
echo "✅ Markdown linting completed"
|
|
|
|
- name: Check for broken links
|
|
run: |
|
|
echo "=== CHECKING FOR BROKEN LINKS ==="
|
|
find docs -name "*.md" -not -path "*/archive/*" -exec markdown-link-check {} \; 2>/dev/null || {
|
|
echo "⚠️ Link checking completed with warnings"
|
|
exit 0
|
|
}
|
|
echo "✅ Link checking completed"
|
|
|
|
- name: Validate YAML frontmatter
|
|
run: |
|
|
echo "=== VALIDATING YAML FRONTMATTER ==="
|
|
find docs -name "*.md" -not -path "*/archive/*" | while read file; do
|
|
if head -5 "$file" | grep -q "^---"; then
|
|
echo "✅ $file has frontmatter"
|
|
fi
|
|
done
|
|
echo "✅ YAML frontmatter validation completed"
|
|
|
|
- name: Check documentation structure
|
|
run: |
|
|
echo "=== CHECKING DOCUMENTATION STRUCTURE ==="
|
|
required_files=(
|
|
"docs/README.md"
|
|
"docs/MASTER_INDEX.md"
|
|
)
|
|
for file in "${required_files[@]}"; do
|
|
if [[ -f "$file" ]]; then
|
|
echo "✅ $file exists"
|
|
else
|
|
echo "❌ $file missing"
|
|
fi
|
|
done
|
|
echo "✅ Documentation structure check completed"
|
|
|
|
- name: Generate documentation report
|
|
if: always()
|
|
run: |
|
|
echo "=== DOCUMENTATION STATISTICS ==="
|
|
echo "Total markdown files: $(find docs -name "*.md" | wc -l)"
|
|
echo "Total documentation size: $(du -sh docs | cut -f1)"
|
|
echo "Categories: $(ls -1 docs | wc -l)"
|
|
echo "✅ Documentation validation completed"
|
|
|
|
- name: Validation Summary
|
|
if: always()
|
|
run: |
|
|
echo "=== DOCUMENTATION VALIDATION SUMMARY ==="
|
|
echo "✅ Markdown linting: completed"
|
|
echo "✅ Link checking: completed"
|
|
echo "✅ YAML frontmatter: validated"
|
|
echo "✅ Structure check: completed"
|
|
echo "✅ Documentation validation finished successfully"
|