chore(external docs): deduplicate codec/framing schemas in generated Cue docs#25364
Draft
thomasqueirozb wants to merge 2 commits intomasterfrom
Draft
chore(external docs): deduplicate codec/framing schemas in generated Cue docs#25364thomasqueirozb wants to merge 2 commits intomasterfrom
thomasqueirozb wants to merge 2 commits intomasterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The doc generator was inlining the full
DeserializerConfig,SerializerConfig, and bothFramingConfigschemas into every component Cue file that uses decoding, encoding, or framing. This meant adding a new codec variant touched every source or sink file instead of one place.The generator now walks each component's resolved schema recursively, detects codec/framing schemas by structure (tag-field description text and decoder-only enum variants), extracts them into three shared files, and replaces them with small per-component Cue conjunctions that contribute only the per-component variation (
required,default).Shared definitions appear in
decoders.cue,encoders.cue, andframing.cue; component files reference them with 2–4 line conjunctions instead of hundreds of inlined lines. Net: −23,741 lines across 67 component files.Vector configuration
NA
How did you test this PR?
Ran
make generate-component-docsand comparedjq -S . website/data/docs.jsonbefore and after. The diff is nearly identical, with only the added definitions as a diff.Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.References
NA