Document shared loading and integration upgrades
This commit is contained in:
@@ -61,6 +61,10 @@ func FromConfigKit[I, S, T any](
|
||||
// Discovery and rendering use the focused inspection, while explicit paths and
|
||||
// comparison retain ConfigKit's native semantics. Construction and help do not
|
||||
// load configuration, and a nil loader is recorded as a construction issue.
|
||||
// The loader receives each operation's selection, input, and shared state.
|
||||
// A valid absent subtree can be acquired, but rendering its effective value
|
||||
// reports the native unavailable-value error. An unavailable inspection returns
|
||||
// an operational error with any whole-load evidence already acquired.
|
||||
func FromConfigKitSubtree[I, S, T any](
|
||||
name, summary string,
|
||||
path configkit.Path,
|
||||
|
||||
@@ -4,6 +4,12 @@
|
||||
// Use AppCommand for one application configuration loader, or Command with a
|
||||
// Suite for multiple named configurations and application-specific flags.
|
||||
// Install the returned command with commandkit.New or App.Register.
|
||||
//
|
||||
// FromConfigKitSubtree adapts an ordinary typed loader and native path to a
|
||||
// focused scope, retaining whole-load sources, findings, and validation.
|
||||
// View.Paths selects native listing candidates; nil falls back to Metadata.
|
||||
// Explicit paths and comparison retain upstream semantics.
|
||||
//
|
||||
// Importing this package alone installs no commands.
|
||||
//
|
||||
// ConfigKit owns configuration loading and interpretation. CommandKit formats
|
||||
|
||||
25
integrations/ckconfig/docs/releases/v0.10.0.md
Normal file
25
integrations/ckconfig/docs/releases/v0.10.0.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# CommandKit ckconfig v0.10.0
|
||||
|
||||
Candidate note; publication is pending.
|
||||
|
||||
CommandKit ckconfig v0.10.0 adopts ConfigKit v1.4.0 and adds native focused
|
||||
configuration scopes. It continues to select CommandKit core v0.7.0 and Go
|
||||
1.27.0 as the consumer minimum.
|
||||
|
||||
## Compatibility and upgrade
|
||||
|
||||
`FromConfigKitSubtree` adapts an application-owned typed result loader and a
|
||||
ConfigKit path to the standard scope operations. Loading and validation cover
|
||||
the whole result; focused output and comparison use native inspection while
|
||||
sources and diagnostics retain whole-load context. See the
|
||||
[consumer guide](../../../../docs/consumers/guide.md#configkit-scopes) and
|
||||
[ConfigKit v1.4.0 notes](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.4.0/docs/releases/v1.4.0.md).
|
||||
|
||||
`View.Paths` optionally supplies native path-discovery candidates. When it is
|
||||
nil, existing custom scopes continue to enumerate `View.Metadata`; metadata
|
||||
still describes and filters candidates. The added exported field can break
|
||||
positional `View` literals. Convert them to keyed literals before upgrading.
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.10.0/integrations/ckconfig/COPYRIGHT) |
|
||||
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.10.0/integrations/ckconfig/LICENSE) |
|
||||
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.10.0/integrations/ckconfig/docs/oss/attribution.md)
|
||||
Reference in New Issue
Block a user