docs: add schema migration rfc [0/3]#234
Open
dmcilvaney wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new developer RFC documenting a proposed “lazy schema migration” approach for component lock-file fingerprints, aiming to prevent repo-wide lock churn when config schema or fingerprinting logic evolves.
Changes:
- Introduces RFC 002 describing the problem (lock-file drift on additive schema changes) and a layered solution (omitempty-by-default inclusion + versioned fingerprint replay + future schema-version migration).
- Documents design rationale, alternatives considered, incremental delivery plan, and open questions for future implementation.
dmcilvaney
force-pushed
the
damcilva/schema_version
branch
from
a2712d3 to
4ee9260
Compare
dmcilvaney
force-pushed
the
damcilva/schema_version
branch
from
ea112e2 to
b505fe1
Compare
dmcilvaney
changed the title
… substrate Relocates the projectV1/no-separate-normalizer reconciliation that had leaked into the reset-cutover branch down onto the RFC branch, and makes canonical JSON (JCS) the chosen serialization throughout: projectVN builds a JSON projection tree, the combiner assembles one document and JCS-serializes + sha256. The hand-rolled length-prefixed byte encoder is demoted to an 'Alternatives considered' entry (retained as a fallback). Adds a 'Serialization substrate' subsection (why JCS over stdlib encoding/json; the JSON-safe integer bound), a grammar-parser 'also considered' note, and a gowebpki/jcs dependency trade-off. Reconciles the encoding table, code example, decisions index, D4, and PR A1.
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.
Possible implementation at #243