Skip to content

Commit 1148bfd

Browse files
committed
docs: add Vale CI section to DOCS-TESTING.md
1 parent 92f2f93 commit 1148bfd

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

DOCS-TESTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,28 @@ Vale can raise different alert levels:
614614

615615
For 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

619641
docs-v2 uses [Lefthook](https://github.com/evilmartians/lefthook) to manage Git hooks that run automatically during pre-commit and pre-push.

0 commit comments

Comments
 (0)