Record completed configuration outcome remediation

This commit is contained in:
2026-11-16 19:03:21 +00:00
parent 21dac4f89e
commit 735b35a0a1
2 changed files with 30 additions and 22 deletions

View File

@@ -1,9 +1,10 @@
# Invalid configuration outcomes # Invalid configuration outcomes
Status — accepted feature roadmap, pending implementation. The user has Status — implemented, with review remediation complete. The
accepted the targeted behavior and both design decisions below. The [implementation plan](implementation.md) and [remediation record](remediation.md)
[implementation plan](implementation.md) owns the ordered work, exact code record the completed work and verification. Publication and downstream dependency
mapping, shared API signature, and verification. alignment remain in the [release handoff](future.md#configuration-outcome-release-handoff).
The accepted behavior and design decisions are recorded below.
## Purpose ## Purpose
@@ -17,7 +18,7 @@ validation, diagnostic meaning, and their public error contracts. Application
commands own their domain outcomes. These responsibilities follow the commands own their domain outcomes. These responsibilities follow the
[architecture policy](../policy/architecture.md#ownership-boundaries). [architecture policy](../policy/architecture.md#ownership-boundaries).
## Current baseline ## Historical baseline
The reviewed baseline is CommandKit commit The reviewed baseline is CommandKit commit
`1e92a87706e44684ee34395245e5b633474677e0`, following the publication of `1e92a87706e44684ee34395245e5b633474677e0`, following the publication of
@@ -32,19 +33,20 @@ while Audita's processing command returned the same diagnostic with status `2`.
The report's reproduction is retained in Audita's The report's reproduction is retained in Audita's
[upstream handoff](https://forge.maximumdirect.net/eric/audita/src/commit/a355f05a273d6ac9d577eab8d30caa60cb74eee8/docs/roadmap/implementation.md). [upstream handoff](https://forge.maximumdirect.net/eric/audita/src/commit/a355f05a273d6ac9d577eab8d30caa60cb74eee8/docs/roadmap/implementation.md).
The review confirmed the behavior through Audita's existing regression tests and The initial review confirmed the baseline behavior through Audita's existing
a temporary public-API reproduction against the aligned CommandKit workspace. regression tests and a temporary public-API reproduction against the aligned
CommandKit workspace.
The latter covered catalog listing and all five configuration operations in both The latter covered catalog listing and all five configuration operations in both
the application and PromptKit scopes, including wrapped ConfigKit loading errors the application and PromptKit scopes, including wrapped ConfigKit loading errors
and already-canceled contexts. and already-canceled contexts.
- [FromConfigKit](../../integrations/ckconfig/configkit_adapter.go) and - [FromConfigKit](../../integrations/ckconfig/configkit_adapter.go) and
[the PromptKit adapters](../../integrations/ckprompt/adapters.go) preserve the [the PromptKit adapters](../../integrations/ckprompt/adapters.go) preserved the
ConfigKit loading error and adapt its diagnostic evidence. ConfigKit loading error and adapted its diagnostic evidence.
- [configFailure](../../integrations/ckconfig/operations.go) and - [configFailure](../../integrations/ckconfig/operations.go) and
[definitionFailure](../../integrations/ckprompt/command.go) construct operational [definitionFailure](../../integrations/ckprompt/command.go) constructed operational
outcomes for the affected failures. Configuration comparison and validation outcomes for the affected failures. Configuration comparison and validation
also reach the former helper. also reached the former helper.
- ConfigKit's public `LoadError` represents several kinds of loading failure, - ConfigKit's public `LoadError` represents several kinds of loading failure,
including malformed YAML, acquisition errors, and schema or callback problems. including malformed YAML, acquisition errors, and schema or callback problems.
Its public diagnostic codes provide the classification evidence. Its error Its public diagnostic codes provide the classification evidence. Its error
@@ -54,10 +56,10 @@ and already-canceled contexts.
and `config validate` can report failed validation. Cancellation observed and `config validate` can report failed validation. Cancellation observed
before acquisition leaves stdout empty in the reviewed command paths. before acquisition leaves stdout empty in the reviewed command paths.
The current [CLI contract](../cli.md#outcome-status) assigns loading failures At that baseline, the published CLI contract assigned loading failures status
status `1`, with more specific statements in the configuration comparison, `1`. The implemented change classifies identifiable invalid configuration as
requirements, validation, and smoke sections. This roadmap proposes a deliberate usage status `2`, with operational fallback, as described in the
change to that published status behavior. [current CLI contract](../cli.md#configuration-failure-classification).
## Targeted end state ## Targeted end state

View File

@@ -1,6 +1,6 @@
# Configuration outcome review remediation # Configuration outcome review remediation
Status — R1 complete, R2 open. Findings from the stage-by-stage review of Status — R1 and R2 complete. Findings from the stage-by-stage review of
[the implementation plan](implementation.md) at commit [the implementation plan](implementation.md) at commit
`8a22dd6`. Review findings concern the accepted `8a22dd6`. Review findings concern the accepted
[feature target](invalid-configuration-outcomes.md). [feature target](invalid-configuration-outcomes.md).
@@ -79,13 +79,19 @@ adaptation of supplied error evidence.
## R2 — Reconcile feature-roadmap status and baseline wording ## R2 — Reconcile feature-roadmap status and baseline wording
Priority — P3. Status — open. Affects Stage 5 documentation consistency. Priority — P3. Status — complete. Affects Stage 5 documentation consistency.
The [feature roadmap](invalid-configuration-outcomes.md) still says Completed by marking the feature as implemented with review remediation complete,
"pending implementation" at its opening. Its baseline section also describes linking the release handoff, and labeling the old status behavior and failure
the current CLI contract as assigning loading failures status `1` and presents helpers as historical baseline evidence. Verified the document against the
the status change as proposed. Meanwhile, the implementation plan records all implemented classifier, current CLI contract, and pending release coordination.
stages complete, and the current Local Markdown links/fragments and whitespace checks passed.
At review time, the [feature roadmap](invalid-configuration-outcomes.md) said
"pending implementation" at its opening. Its baseline section also described
the current CLI contract as assigning loading failures status `1` and presented
the status change as proposed. Meanwhile, the implementation plan recorded all
stages complete, and the
[CLI reference](../cli.md#configuration-failure-classification) documents the [CLI reference](../cli.md#configuration-failure-classification) documents the
implemented status `2` classification and operational fallback. implemented status `2` classification and operational fallback.