Prepare ckconfig v0.5.0 with released core dependencies
This commit is contained in:
@@ -18,7 +18,7 @@ The following distinguishes published combinations from the current checkout:
|
|||||||
|
|
||||||
| Selection | Core | ckconfig | ckprompt | Upstream libraries and status |
|
| Selection | Core | ckconfig | ckprompt | Upstream libraries and status |
|
||||||
| --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- |
|
||||||
| Published core | v0.4.0 | — | — | Usable independently. |
|
| Published core | v0.5.0 | — | — | Usable independently. |
|
||||||
| Published ConfigKit integration | v0.4.0 | v0.4.0 | — | ConfigKit v1.1.0. |
|
| Published ConfigKit integration | v0.4.0 | v0.4.0 | — | ConfigKit v1.1.0. |
|
||||||
| Earlier matched integration set | v0.3.0 | v0.2.0 | v0.2.0 | ConfigKit v0.8.0 and PromptKit v0.16.0, using their earlier import paths. |
|
| Earlier matched integration set | v0.3.0 | v0.2.0 | v0.2.0 | ConfigKit v0.8.0 and PromptKit v0.16.0, using their earlier import paths. |
|
||||||
| Current source | Local | Local | Local | ConfigKit v1.1.0 and PromptKit v0.20.0; use an aligned workspace until release dependencies are updated. |
|
| Current source | Local | Local | Local | ConfigKit v1.1.0 and PromptKit v0.20.0; use an aligned workspace until release dependencies are updated. |
|
||||||
@@ -26,10 +26,10 @@ The following distinguishes published combinations from the current checkout:
|
|||||||
Install the published core with:
|
Install the published core with:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go get go.maximumdirect.net/commandkit@v0.4.0
|
go get go.maximumdirect.net/commandkit@v0.5.0
|
||||||
```
|
```
|
||||||
|
|
||||||
Core v0.5.0 and ckprompt v0.3.0 have unpublished candidate notes. Current
|
The integration releases being prepared are ckconfig v0.5.0 and ckprompt v0.5.0. Current
|
||||||
ckprompt source calls `ckconfig.AdaptDiagnostics`, which is absent from its
|
ckprompt source calls `ckconfig.AdaptDiagnostics`, which is absent from its
|
||||||
selected released ckconfig v0.4.0 dependency. It therefore needs local
|
selected released ckconfig v0.4.0 dependency. It therefore needs local
|
||||||
ckconfig source in the workspace until [release
|
ckconfig source in the workspace until [release
|
||||||
|
|||||||
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)
|
||||||
@@ -3,7 +3,7 @@ module go.maximumdirect.net/ckconfig
|
|||||||
go 1.27.0
|
go 1.27.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
go.maximumdirect.net/commandkit v0.4.0
|
go.maximumdirect.net/commandkit v0.5.0
|
||||||
go.maximumdirect.net/configkit v1.1.0
|
go.maximumdirect.net/configkit v1.1.0
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6
|
go.yaml.in/yaml/v4 v4.0.0-rc.6
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -8,6 +8,8 @@ github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
|
|||||||
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
go.maximumdirect.net/commandkit v0.4.0 h1:bWqflDWDn98FUCgh+0e+w6LGmvWIkaeJK519H7PjD2Y=
|
go.maximumdirect.net/commandkit v0.4.0 h1:bWqflDWDn98FUCgh+0e+w6LGmvWIkaeJK519H7PjD2Y=
|
||||||
go.maximumdirect.net/commandkit v0.4.0/go.mod h1:ZS98DewKNVBygKVDoh5MFD09CnPlP37dS9pVsID5Eoc=
|
go.maximumdirect.net/commandkit v0.4.0/go.mod h1:ZS98DewKNVBygKVDoh5MFD09CnPlP37dS9pVsID5Eoc=
|
||||||
|
go.maximumdirect.net/commandkit v0.5.0 h1:Ln+bCp+FwCg4tZD3NaMKQXUDB3mPusgwsnRZmb0+3cM=
|
||||||
|
go.maximumdirect.net/commandkit v0.5.0/go.mod h1:ZS98DewKNVBygKVDoh5MFD09CnPlP37dS9pVsID5Eoc=
|
||||||
go.maximumdirect.net/configkit v1.1.0 h1:UzXN2ZMnEkcL0O4YSLqD9qd9M1gb/NWCHQR/H8AaQzA=
|
go.maximumdirect.net/configkit v1.1.0 h1:UzXN2ZMnEkcL0O4YSLqD9qd9M1gb/NWCHQR/H8AaQzA=
|
||||||
go.maximumdirect.net/configkit v1.1.0/go.mod h1:s1zLJ9GGB/1Q4a+aOHMLISonJxWFgNWpA6SpPlOafeA=
|
go.maximumdirect.net/configkit v1.1.0/go.mod h1:s1zLJ9GGB/1Q4a+aOHMLISonJxWFgNWpA6SpPlOafeA=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
||||||
|
|||||||
Reference in New Issue
Block a user