Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Yamllint Processor

Purpose

Lints YAML files using yamllint.

How It Works

Discovers .yml and .yaml files in the project (excluding common build tool directories), runs yamllint on each file, and records success in the cache. A non-zero exit code from yamllint fails the product.

This processor supports batch mode, allowing multiple files to be checked in a single yamllint invocation for better performance.

Source Files

  • Input: **/*.yml, **/*.yaml
  • Output: none (checker)

Configuration

[processor.yamllint]
linter = "yamllint"                          # The yamllint command to run
args = []                                    # Additional arguments to pass to yamllint
extra_inputs = []                            # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
linterstring"yamllint"The yamllint executable to run
argsstring[][]Extra arguments passed to yamllint
extra_inputsstring[][]Extra files whose changes trigger rebuilds