Skip to main content

valid-yaml-document-start

Overview

This rule belongs to the yaml-semantic-validation ruleset and states that:

If a YAML document begins with a %YAML directive, it must be followed in the next line by three dashes --- and no other content in it. In other words, the %YAML directive must be valid and separated correctly from the remaining YAML content.

PropertyValue
EnabledYes
Maximum SeverityBlocking
MessageDid not find expected <document start>.
CodeYAMLSEMANTIC_V101
TypeValidation
Rule SystemSemantic
Broad CategoryDirectives
Tagsyaml data semantic preliminary checks validation yaml document start directive

Suggested Fixes

  • Looks like you missed the line separator '---' after use of a directive.
  • Use only three dashes '---' as the line separator with no other content in that line.

For More Information