YAML Message Folding

When writing YAML string fields intended for one-line or sentence-like messages, prefer folded block scalars (`>`) so embedded newlines render as spaces. Use literal block scalars (`|`) only when you explicitly need to preserve line breaks.

copy reviewer prompt

Prompt

Reviewer Prompt
Deploy Agent

When writing YAML string fields intended for one-line or sentence-like messages, prefer folded block scalars (>) so embedded newlines render as spaces. Use literal block scalars (|) only when you explicitly need to preserve line breaks.

Example:

# Fold newlines into spaces (recommended for sentence-style messages)
message: >
  Fix TCP error
  with updated restriction handling

# Preserve line breaks exactly
message: |
  Fix TCP error
  with updated restriction handling

If you see changelog entries using | where the message should read as a single paragraph, switch to > to match the intended formatting.

Source discussions