Skip to content

docs: document YAML alias and anchor limitations - #26

Merged
SSOHEB merged 1 commit into
SSOHEB:mainfrom
slegarraga:docs/yaml-alias-anchor-limitations
Aug 7, 2026
Merged

docs: document YAML alias and anchor limitations#26
SSOHEB merged 1 commit into
SSOHEB:mainfrom
slegarraga:docs/yaml-alias-anchor-limitations

Conversation

@slegarraga

Copy link
Copy Markdown
Contributor

What & why

Documents how internal/parser handles YAML aliases and anchors so users know what is supported in metadata.yaml. The parser uses gopkg.in/yaml.v3, but it does not expand structural aliases or merge keys, and the guide now says that explicitly.

Closes #15.

Verified behavior

  • A mapping with a direct anchor, such as server: &server, parses normally.
  • An alias used in place of a mapping returns expected mapping node.
  • A merge key such as <<: *base returns expected mapping node.
  • A scalar alias inside a leaf value may decode through the YAML library, but Codrao does not rely on it and the guide treats it as outside the supported contract.

Verification

  • go test ./... passes.

Signed-off-by: Sebastian Legarraga <64795732+slegarraga@users.noreply.github.com>

@SSOHEB SSOHEB left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition! Thanks for your first contribution!

@SSOHEB
SSOHEB merged commit 638f1fe into SSOHEB:main Aug 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Document YAML alias/anchor limitations

2 participants