base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Clarify configuration evidence providers

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-07 15:47:17 +00:00
parent ac113291fc
commit 52f1d99994
7 changed files with 36 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/roadmap/audit/catalog.md
View File

@@ -1,6 +1,6 @@
# Consolidated audit catalog
Status: **18 distinct open findings: 18 P3**, consolidated from 30
Status: **16 distinct open findings: 16 P3**, consolidated from 30
numbered entries in seven audit documents. Reviewed audit state:
`db732e3a1de55c844f77870e1c6db683c2685d5d`.
@@ -191,6 +191,9 @@ consumer without changing core's optional-binding semantics.
## F09 — P3: The configuration provider contract omits its required YAML representation
**Complete.** EffectiveWriter, View and DecodeYAMLReport GoDoc describe the
actual single-document conversion boundary; focused conversion and show tests pass.
`EffectiveWriter` GoDoc promises a native representation but omits that `config
show` converts one supported YAML document through `DecodeYAMLReport`. Custom
providers can supply output that appears compatible with the description yet
@@ -227,6 +230,10 @@ of the documentation correction remains pending.
## F11 — P3: Explanation providers must implement an unused text writer
**Complete.** The interface now requires only Explain; focused tests exercise an
Explain-only provider for focused show and explanations across formats, including
delivery failures. Obsolete writer stubs and the interface-writer assertion were removed.
`ExplanationReader` still requires `WriteExplanation` even though production
show/explain handlers acquire evidence with `Explain` and core renders it. This
burdens custom providers and suggests a presentation responsibility that

8
docs/roadmap/implementation.md
View File

@@ -1,6 +1,6 @@
# Audit remediation implementation plan
Status: in progress; Stages 1–8 complete.
Status: in progress; Stages 1–9 complete.
Baseline: `d492c7747175c01a53261206c2b4356e53453621`. Before this sprint,
intervening changes recorded decisions and retired the completed older
@@ -327,6 +327,12 @@ Complete when both paths use one implementation of the delicate detail policy.
## Stage 9 — Clarify configuration evidence and narrow explanation providers
**Complete.** Provider and YAML conversion GoDoc now describe the current
handoff; `ExplanationReader` only acquires evidence. Focused core YAML conversion
and ckconfig show, explanation, adapter and delivery tests passed in the offline
aligned Go 1.27.0 workspace with `-mod=readonly`, including a custom Explain-only
provider for path show and all explanation formats.
Findings: F09 and F11. Sources: ckconfig `contracts.go`, `show.go`, `explain.go`,
`contracts_adapter_test.go`; core `report_value.go` conversion GoDoc.