File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed
Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change @@ -614,6 +614,28 @@ Vale can raise different alert levels:
614614
615615For more configuration details, see [ Vale configuration] ( https://vale.sh/docs/topics/config ) .
616616
617+ ### CI Integration
618+
619+ Vale runs automatically on pull requests that modify markdown files. The workflow:
620+
621+ 1 . Detects changed markdown files (content, README, instruction files)
622+ 2 . Resolves shared content to consuming product pages
623+ 3 . Maps files to appropriate Vale configs (matching local Lefthook behavior)
624+ 4 . Runs Vale via Docker (` jdkato/vale:latest ` )
625+ 5 . Reports results as inline annotations and a PR summary comment
626+
627+ ** Alert levels:**
628+ - ** Errors** block merging
629+ - ** Warnings** and ** suggestions** are informational only
630+
631+ ** Files checked:**
632+ - ` content/**/*.md `
633+ - ` README.md ` , ` DOCS-*.md `
634+ - ` **/AGENTS.md ` , ` **/CLAUDE.md `
635+ - ` .github/**/*.md ` , ` .claude/**/*.md `
636+
637+ The CI check uses the same product-specific configs as local development, ensuring consistency between local and CI linting.
638+
617639## Pre-commit Hooks
618640
619641docs-v2 uses [ Lefthook] ( https://github.com/evilmartians/lefthook ) to manage Git hooks that run automatically during pre-commit and pre-push.
You can’t perform that action at this time.
0 commit comments