Files
YAMLlint will run on files with the following extensions:.yaml.yml
Configuration
Enable YAMLlint
- Web UI
- .coderabbit.yaml
| Reviews β Tools β Enable YAMLlint | |
| true |
Features
YAMLlint performs several checks:Syntax checks
- YAML validity
- Document structure
Cosmetic checks
- Line length limits
- Trailing whitespace
- Indentation consistency
- Empty lines
- Comments formatting
Configuration File
CodeRabbit loads repository.yamllint.yml or .yamllint.yaml files for this integration if they exist. If not, it passes inline configuration data to yamllint based on the selected review profile.
When we skip YAMLlint
CodeRabbit will skip running YAMLlint when:- YAMLlint is already running in GitHub workflows.
Ignored rules
The following YAMLlint rules are automatically ignored (noisy whitespace/indentation-only rules):trailing-spaces- extra spaces at end of linetrailing spaces- alternate spelling sometimes emitted by YAMLlintindentation- spaces donβt line upnew-line-at-end-of-file- new line at end of filecommas- commas in listscolons- spacing around colonscomments- comment formattingline-length- line length limitsdocument-start- document start requirementsquoted-strings- quoted stringsbraces- whitespace inside braces
Profile behavior
CodeRabbit uses different YAMLlint rule sets based on the review profile:- Chill Mode: Uses the
relaxedrule set - Assertive Mode: Uses the
defaultrule set