diff --git a/docs/roadmap/configkit.md b/docs/roadmap/configkit.md index 2646509..f66e11b 100644 --- a/docs/roadmap/configkit.md +++ b/docs/roadmap/configkit.md @@ -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 diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index ee8373e..a6bdc91 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -335,7 +335,16 @@ implemented native behavior without inventing stronger guarantees. ## Stage 5: Verify The Complete Work Set And Record The Handoff -Status: Pending. Depends on Stage 4. +Status: Complete. Depends on Stage 4. + +Completion evidence: reviewed the full change set against the planned baseline, +confirmed the dependency revision and single-load integration, all five stage +acceptance areas, the preserved compatibility and ownership boundaries, and the +absence of deferred interfaces or release automation. Final tests, race tests, +vet, build, diff checks, pinned links, and all five maintained example commands +passed. The feature roadmap now records implementation as delivered, the policy +roadmap points to its historical implementation plan, and the release handoff +is recorded below; no release was created. Files: this plan and `docs/roadmap/configkit.md`; the historical-reference portion of `docs/roadmap/policy.md`; other previously affected files only if @@ -386,6 +395,18 @@ Acceptance: all five stages have truthful completion evidence, the feature roadmap reflects delivery, historical navigation remains accurate, and the final application work matches the agreed scope. +### Release Handoff + +Scriptorium now selects ConfigKit v0.5.0 and supports backend inheritance. +`extends` is globally reserved in application input mappings and has no escape +in this upstream version. Parent backends remain registered ordinary +backends. Application paths remain working-directory-relative, and +`api_key_env` remains a visible environment-variable name passed to Promptkit; +Scriptorium does not resolve credential values through ConfigKit. The next +intended minor is currently v0.16.0. Version availability checks, its release +note and notice links, roadmap retirement, tagging, and publication are separate +release-preparation work under `docs/release.md`; no release was created here. + ## Open Questions None within the accepted scope. Native inheritance and its reserved-key diff --git a/docs/roadmap/policy.md b/docs/roadmap/policy.md index ad2d2b4..4231e6b 100644 --- a/docs/roadmap/policy.md +++ b/docs/roadmap/policy.md @@ -5,8 +5,9 @@ Agreed and delivered on 2026-09-28. This roadmap replaces the earlier licensing-only proposal with alignment of the complete applicable policy set and its supporting documentation. It defines the targeted end state -and required changes; the [implementation plan](implementation.md) owns ordered -stages and their verification. +and required changes. Its completed implementation plan is preserved in Git at +`git show 8b6c12f912b28ac00016f047f9846798a5de95d9:docs/roadmap/implementation.md`; +the current `implementation.md` belongs to a later work set. The next release summary should mention the policy and licensing alignment, the already-selected GPL-3.0-or-later application grant, and the separate