docs(architecture): add ADR for template extends#582
Open
arodage wants to merge 8 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Architecture Decision Record (ADR) proposing single-level extends support for image templates, documenting the motivation, merge approach (defaults → parent → child), validation rules, and expected consequences within ICT’s template merge system.
Changes:
- Introduces a proposed ADR describing the
extendsfield semantics and constraints (single-level only, target match, circular/chained rejection). - Documents the intended merge flow leveraging existing
MergeConfigurations()calls. - Captures risks/mitigations and alternatives considered for template reuse.
…d path-safety wording
3 tasks
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.
Merge Checklist
All boxes should be checked before merging the PR
Description
Adds an Architecture Decision Record (ADR) proposing
extendssupport for image templates.Problem: Users who need to customize existing templates must copy the entire template and modify it. When the original template is updated, every copy must be manually re-synchronized.
Proposal: Add an optional
extendsfield to user templates that enables linear inheritance chains. Each template may extend at most one parent (single inheritance, no diamond problem). The merge is applied iteratively using the existingMergeConfigurations()as a fold operation, producing deterministic results at any chain depth.Key design decisions:
MergeConfigurations()applied iteratively (OS defaults -> root -> level 1 -> ... -> leaf)resolvesubcommand to inspect the merged resultAny Newly Introduced Dependencies
None. This is a documentation-only change.
How Has This Been Tested?
Documentation-only change. No code changes to test.