Complete ConfigKit inheritance implementation handoff
This commit is contained in:
@@ -2,7 +2,8 @@
|
||||
|
||||
## Status And Intent
|
||||
|
||||
Accepted feature direction, recorded on 2026-10-03; implementation is pending.
|
||||
Implemented in Scriptorium's current source on 2026-10-03; release preparation
|
||||
remains separate work.
|
||||
This roadmap replaces the completed initial ConfigKit adoption roadmap. That
|
||||
earlier work and its resolved decisions remain available in Git at
|
||||
`9849c6b:docs/roadmap/configkit.md`.
|
||||
@@ -15,8 +16,9 @@ retains Scriptorium's existing discovery and application path policies rather
|
||||
than expanding the configuration interface merely because upstream added
|
||||
library APIs.
|
||||
|
||||
This document owns the desired end state and required changes. A later
|
||||
implementation plan will own ordered implementation instructions. The
|
||||
This document retains the target state, rationale, compatibility scope, and
|
||||
deferred work. Implementation sequencing and completion evidence were recorded
|
||||
in a separate work plan. The
|
||||
[architecture policy](../policy/architecture.md),
|
||||
[configuration contract](../config.md), and
|
||||
[ADR 0004](../adr/0004-definition-boundary.md) establish the existing application
|
||||
@@ -55,8 +57,9 @@ An isolated review using a temporary module file passed Scriptorium's existing
|
||||
test suite and build against v0.5.0. CLI checks confirmed effective backend
|
||||
inheritance, explicit zero and false replacements, and inheritance explanation.
|
||||
They also confirmed that a literal `extra_params.extends` accepted by v0.4.2
|
||||
fails under v0.5.0. This evidence supports adoption; it does not establish
|
||||
completion of the planned regression coverage, race testing, or vet checks.
|
||||
fails under v0.5.0. This exploratory evidence informed adoption; the focused
|
||||
regression coverage and full validation are recorded by the completed
|
||||
implementation work.
|
||||
|
||||
## Targeted End State
|
||||
|
||||
@@ -102,10 +105,10 @@ remains the canonical detailed specification:
|
||||
treatment as other backends. This adoption adds no template-only collection,
|
||||
registration suppression, or validation exemption.
|
||||
|
||||
The backend example should demonstrate reusable complete parent settings and
|
||||
a child with meaningful explicit replacements, including zero queue capacity
|
||||
and a false dynamic parameter. Parameter names and values must be illustrative
|
||||
and contain no credentials.
|
||||
The maintained backend example demonstrates reusable complete parent settings
|
||||
and a child with meaningful explicit replacements, including zero queue
|
||||
capacity and a false dynamic parameter. Parameter names and values are
|
||||
illustrative and contain no credentials.
|
||||
|
||||
### Inspection And Credential Handling
|
||||
|
||||
@@ -169,41 +172,23 @@ inheritance feature and reserved-key migration impact. Final version selection
|
||||
and publication remain release preparation work; this roadmap adds no
|
||||
publication gate or recurring upstream probe.
|
||||
|
||||
## Work Needed From The Baseline
|
||||
## Scope Delivered
|
||||
|
||||
- **Dependency and attribution maintenance:** update `go.mod` and `go.sum`
|
||||
to the published v0.5.0 tag. Update ConfigKit's version and exact-commit
|
||||
source, COPYRIGHT, and LICENSE links in `docs/oss/attribution.md` under the
|
||||
[OSS policy](../policy/oss.md). Existing standard license texts remain
|
||||
applicable; check the selected upstream notices. Leave unrelated dependencies
|
||||
and historical release records alone.
|
||||
- **Integration review:** verify the existing `internal/config` definition,
|
||||
loading, normalization, and runtime conversion preserve resolved inherited
|
||||
values and explicit presence. Make only changes needed for that integration;
|
||||
upstream already implements the inheritance machinery.
|
||||
- **Application coverage:** add representative tests at the configuration and
|
||||
CLI boundaries for inherited backend settings, explicit zero/false and
|
||||
nullable replacements, interaction with an imported parent and selected
|
||||
overlay, explainable derivation, and reserved-key failure. Verify inherited
|
||||
backend settings reach existing runtime mapping or registration. Use small
|
||||
fixtures and behavior assertions rather than duplicating ConfigKit's
|
||||
exhaustive inheritance, parser, or metadata matrix.
|
||||
- **Maintained examples:** add a runnable application configuration example
|
||||
under `examples/` showing backend inheritance, and link it from the owning
|
||||
configuration documentation. Validate it through the real application
|
||||
loading and inspection path without credentials or provider calls.
|
||||
- **Current documentation:** update `docs/config.md` with the user-facing
|
||||
inheritance support and compatibility guidance. Update relevant dependency
|
||||
references in `docs/development.md` and `docs/policy/architecture.md`;
|
||||
reflect integration mechanics in `docs/internal/sources.md` and adapter
|
||||
documentation where needed. CLI syntax is unchanged; update CLI documentation
|
||||
only where its inspection description needs clarification. Link the pinned
|
||||
upstream contract rather than copying its full specification.
|
||||
- **Validation and release handoff:** run the existing deterministic suite,
|
||||
race suite, vet, build, diff checks, and affected example/link checks. Prepare
|
||||
accurate minor-release migration information when preparing the release.
|
||||
Routine checks remain governed by the existing development and release
|
||||
policies, rather than becoming new requirements introduced by this roadmap.
|
||||
- **Dependency and attribution:** selected the published ConfigKit v0.5.0 tag
|
||||
and updated its exact-commit attribution links without changing unrelated
|
||||
dependencies or historical release records.
|
||||
- **Integration and coverage:** retained the single configuration-loading
|
||||
pipeline and added focused configuration and CLI tests for inheritance,
|
||||
presence, provenance, source assembly, inspection, runtime conversion, and
|
||||
Promptkit registration behavior.
|
||||
- **Maintained example and documentation:** added a runnable backend-inheritance
|
||||
configuration and updated its README, configuration, CLI, architecture, and
|
||||
source-internals references while leaving CLI syntax and deferred interfaces
|
||||
unchanged.
|
||||
- **Validation and release handoff:** completed the deterministic tests, race
|
||||
tests, vet, build, diff, link, and example-command checks. Release-note
|
||||
preparation and publication remain separate work under the existing
|
||||
development and release policies.
|
||||
|
||||
## Deferred Scope
|
||||
|
||||
@@ -220,11 +205,11 @@ permanent prohibitions on future requested features.
|
||||
|
||||
## Completion Criteria
|
||||
|
||||
Adoption is complete when the published dependency is selected; native
|
||||
inheritance works through the shared execution and inspection pipeline;
|
||||
backend values and explicit replacements reach the existing runtime boundary;
|
||||
focused tests and a maintained example demonstrate the integration; and
|
||||
current documentation and attribution describe the selected version accurately.
|
||||
Adoption is delivered: the published dependency is selected; native inheritance
|
||||
works through the shared execution and inspection pipeline; backend values and
|
||||
explicit replacements reach the existing runtime boundary; focused tests and a
|
||||
maintained example demonstrate the integration; and current documentation and
|
||||
attribution describe the selected version accurately.
|
||||
|
||||
The reserved-key compatibility impact must be explicit, and established
|
||||
credential visibility, path interpretation, discovery, and framework ownership
|
||||
|
||||
Reference in New Issue
Block a user