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

Document ConfigKit adoption

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-04 15:05:42 +00:00
parent 42176a7ac4
commit 5ccdcb91c9
10 changed files with 118 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
integrations/ckconfig/README.md
View File

@@ -7,9 +7,9 @@ itself.
## Module
The module path is `go.maximumdirect.net/ckconfig`. Version v0.2.0 uses
`go.maximumdirect.net/commandkit v0.3.0` and
ConfigKit; it does not import PromptKit. See the
The module path is `go.maximumdirect.net/ckconfig`. The prepared v0.3.0
candidate requires Go 1.27.0 and uses `go.maximumdirect.net/commandkit v0.3.0` and
`go.maximumdirect.net/configkit v1.1.0`; it does not import PromptKit. See the
[consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/consumers/guide.md#configkit-scopes)
for exact callback and lifetime contracts.
@@ -26,9 +26,9 @@ scopes, selectors, input checks, and state shared by the selected acquisitions
or comparison in a config invocation. `ckconfig.FromConfigKit` adapts a typed
ConfigKit loader. The `config` command family exposes scope discovery and the
validate, show, sources, explain, and diff operations supported by the declared
scopes. Source reports include native destination, placement, unresolved
destination, and source version-check evidence. Comparison returns ConfigKit's
native records to the YAML report path; the
scopes. Source reports include native destination, placement, destination
fallback, version evidence, and empty-import selections. Comparison returns
ConfigKit's native records to the YAML report path; the
[CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/cli.md#compare-configuration-selections)
owns its operator details.

4
integrations/ckconfig/doc.go
View File

@@ -1,10 +1,10 @@
// Package ckconfig, provided by go.maximumdirect.net/ckconfig, provides
// CommandKit's optional ConfigKit integration. Its
// CommandKit's optional ConfigKit v1.1.0 integration, requiring Go 1.27.0. Its
// canonical Command declaration installs the standard config command family
// through the core commandkit package. Applications can install CommandKit
// RoutingRule declarations alongside it through commandkit.New or
// App.Register. Source reports preserve ConfigKit's destination, placement,
// and version-check evidence. Invocation reporting applies CommandKit's shared
// version, and empty-import evidence. Invocation reporting applies CommandKit's shared
// visibility and delivery policy; provider warnings remain independent of
// failure explanations. Importing ckconfig alone installs no commands.
package ckconfig

25
integrations/ckconfig/docs/releases/v0.3.0.md Normal file
View File

@@ -0,0 +1,25 @@
# CommandKit ckconfig v0.3.0
## Summary
This candidate adopts `go.maximumdirect.net/configkit v1.1.0` and requires Go
1.27.0, while retaining `go.maximumdirect.net/commandkit v0.3.0`. It updates
configuration source reports to expose ConfigKit's current evidence.
## Migration
Change ConfigKit imports from `gitea.maximumdirect.net/eric/ConfigKit` to
`go.maximumdirect.net/configkit`. Values from the two paths have distinct Go
type identities. Update application loaders and provider values together with
ckconfig. Published ckprompt v0.2.0 continues to use ckconfig v0.2.0 and the old
ConfigKit identity; it does not compose with this candidate.
Source reports rename `destination_unresolved` to `destination_is_fallback` and
`version_check` to `version_evidence`, use the native `main` layer name, and add
`empty_import_selections` records (or `[]` when empty). Update report consumers.
See the [consumer migration guide](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.3.0/docs/consumers/guide.md#configkit-v11-migration)
for links to upstream configuration and API changes.
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.3.0/integrations/ckconfig/COPYRIGHT) |
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.3.0/integrations/ckconfig/LICENSE) |
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckconfig/v0.3.0/integrations/ckconfig/docs/oss/attribution.md)

4
integrations/ckconfig/examples/simple/README.md
View File

@@ -1,7 +1,9 @@
# Simple consumer
This example imports `go.maximumdirect.net/ckconfig` and
`go.maximumdirect.net/commandkit`; use ckconfig v0.2.0 with core v0.3.0.
`go.maximumdirect.net/commandkit`; use the ckconfig v0.3.0 candidate with core
v0.3.0, ConfigKit v1.1.0, and Go 1.27.0. Set `GOWORK=off GOTOOLCHAIN=local`
for the commands below.
Run the maintained example with: