Vale "spelling" errors fail the docs job in CI
Vale ran your prose style checks and reported errors from the spelling rule for words it does not recognize. When Vale prints "N errors" and the min alert level is error, the job exits non-zero.
What this error means
Vale ends with a summary like "2 errors, 0 warnings and 0 suggestions" where the errors are Vale.Spelling on domain terms, product names, or CLI flags.
docs/guide.md
12:8 error Did you really mean 'Kubernetes'? Vale.Spelling
40:3 error Did you really mean 'kubectl'? Vale.Spelling
2 errors, 0 warnings and 0 suggestionsCommon causes
Project vocabulary is not in an accept list
Product names, commands, and jargon (kubectl, OAuth, Latchkey) are not standard dictionary words, so Vale.Spelling flags them.
No custom vocabulary is configured
Without a Vocab folder and accept.txt, Vale checks only its built-in dictionary and treats every unknown token as a spelling error.
How to fix it
Add terms to a project accept.txt vocabulary
- Create
styles/config/vocabularies/Project/accept.txt. - List each accepted term on its own line (regex allowed).
- Reference the vocabulary in
.vale.iniwithVocab = Project.
# styles/config/vocabularies/Project/accept.txt
Kubernetes
kubectl
OAuth
LatchkeyWire the vocabulary into .vale.ini
Point Vale at the vocabulary so accepted terms stop being spelling errors.
StylesPath = styles
Vocab = Project
[*.md]
BasedOnStyles = ValeHow to prevent it
- Maintain a project
accept.txtand add new terms with the doc that introduces them. - Commit the Vocab folder so CI and local runs share the same word list.
- Review Vale errors in PRs so real typos are still caught.