Prepare ckconfig v0.5.0 with released core dependencies
This commit is contained in:
39
integrations/ckconfig/docs/releases/v0.5.0.md
Normal file
39
integrations/ckconfig/docs/releases/v0.5.0.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# CommandKit ckconfig v0.5.0
|
||||
|
||||
CommandKit ckconfig v0.5.0 improves configuration explanations, preserves
|
||||
available inspection evidence after loader failures, and uses CommandKit core
|
||||
v0.5.0 for reporting and input handling. ConfigKit remains at v1.1.0, and the
|
||||
consumer minimum remains Go 1.27.0.
|
||||
|
||||
## Changes
|
||||
|
||||
- Configuration explanations render the same acquired evidence in text, YAML,
|
||||
and JSON, including available field metadata, history, and source labels.
|
||||
- Failed loads retain available ConfigKit result evidence for inspection.
|
||||
Cancellation during aggregate configuration display remains an operation
|
||||
failure rather than being reported as a rendering failure.
|
||||
- The new `AdaptDiagnostics` helper captures native ConfigKit diagnostics for
|
||||
CLI presentation. Both standard integrations use the same adapter.
|
||||
- Validation and path discovery avoid rebuilding filter sets and subtree
|
||||
prefixes repeatedly. Scope setup and operation preparation are simpler,
|
||||
preserving independent comparison inputs and existing CLI behavior.
|
||||
|
||||
## Compatibility and upgrade
|
||||
|
||||
Select `go.maximumdirect.net/ckconfig v0.5.0` with CommandKit core v0.5.0.
|
||||
Custom `ExplanationReader` implementations need only `Explain`; the interface
|
||||
no longer requires `WriteExplanation`. CommandKit renders the acquired evidence
|
||||
instead of invoking a provider's text writer. Applications that customized that
|
||||
writer should review their text output.
|
||||
|
||||
Effective configuration writers supply one safe YAML document. Conversion
|
||||
preserves resolved scalar types rather than formatting or comments. Core
|
||||
v0.5.0 preserves numeric-looking strings and explicit numeric tags; review
|
||||
callers that relied on automatic conversion of strings into numbers.
|
||||
|
||||
See the [configuration CLI reference](../../../../docs/cli.md#configuration-scopes)
|
||||
and [consumer guide](../../../../docs/consumers/guide.md#configkit-scopes).
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.5.0/integrations/ckconfig/COPYRIGHT) |
|
||||
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.5.0/integrations/ckconfig/LICENSE) |
|
||||
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.5.0/integrations/ckconfig/docs/oss/attribution.md)
|
||||
Reference in New Issue
Block a user