
Comments That Help the Next Person Reading Your YAML
What to write in YAML comments, what to leave out and how to lint comment style. Includes yamllint output for spacing and indentation, and what tools drop.
Backups you have actually restored, replicas that keep up, upgrades without drama, and a database that stays healthy.

What to write in YAML comments, what to leave out and how to lint comment style. Includes yamllint output for spacing and indentation, and what tools drop.

Write a JSON Schema for a YAML config, run check-jsonschema in CI, get every error with a path, and know that the loader decides what NO and 3.10 are.

Put shared settings in one anchored block and merge it into each service. The web service replaced the whole environment block, since the merge is shallow.

Keep one base file and small overrides per environment, merge them in order and print the effective config with the source of each value. Tested layers.

YAML has no include. Two ways to split a config: numbered fragments merged in order, and a custom include tag on a safe loader. Both tested, with traps.

How to lay out YAML config so it stays correct: base and overlays, secret references, a schema, strict loading, key style, comments and a CI check, tested.
We send one email when a new article is published. No spam.