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

Prepare core and integration release notes

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-18 13:51:15 +00:00
parent 654d1b4a6d
commit 841e60fed3
3 changed files with 127 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
integrations/ckconfig/docs/releases/v0.1.0.md
View File

@@ -1,20 +1,43 @@
# CommandKit ckconfig v0.1.0
Initial independently versioned release of the optional ConfigKit integration.
It provides `ckconfig.AppCommand`, `ckconfig.Command`, and `ckconfig.FromConfigKit`
for building core command declarations from ConfigKit scopes and loaders. Add
the module only when an application uses ConfigKit integration; it is not part
of the core module.
## Summary
This release follows the core API replacement in CommandKit v0.2.0. Consumers
must use the current captured declaration API; this release does not claim
compatibility with the earlier registration API.
The initial independently versioned ConfigKit integration provides configuration
inspection and native comparison through CommandKit command declarations. It
uses CommandKit v0.2.0 and ConfigKit v0.8.0 and is distributed as a source-only
Go module.
This integration adopts ConfigKit v0.7.1 and adds paired configuration
comparison through `config diff`. A scope can provide comparison independently
of ordinary configuration acquisition.
## Features
See the [module README](../../README.md), [consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckconfig/v0.1.0/docs/consumers/guide.md),
- `ckconfig.AppCommand`, `ckconfig.Command`, and `ckconfig.FromConfigKit` adapt
application loaders and named scopes into explicitly installed declarations.
- The `config` family exposes scopes, validation, effective YAML, sources, and
path explanation according to each scope's declared capabilities.
- `config diff` compares two selections through ConfigKit's native API and emits
YAML additions, right-side changes, and deletion paths. Comparison can be
provided independently of ordinary configuration acquisition; differences
alone do not make the command fail.
- Source reports expose native destination, placement, unresolved destination,
and version-check evidence alongside the source inventory.
- Typed selectors, per-side comparison inputs, and invocation state support
application-specific acquisition without transferring configuration semantics
to CommandKit.
## Requirements and adoption
**Go 1.26.0 or newer is required.** Add
`gitea.maximumdirect.net/eric/CommandKit/integrations/ckconfig@v0.1.0`, then pass
the returned declaration to `commandkit.New` or `App.Register`. Importing the
module does not install commands.
Applications migrating from the ConfigKit helpers in CommandKit v0.1.0 must
move to the separate module and update scope, loader, binding, and installation
wiring for the core v0.2.0 API. Update report consumers for the added source
evidence and any newly installed comparison commands. ConfigKit remains the
authority on configuration loading, inspection, and comparison semantics.
See the [module README](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckconfig/v0.1.0/integrations/ckconfig/README.md),
[consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckconfig/v0.1.0/docs/consumers/guide.md),
and [CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckconfig/v0.1.0/docs/cli.md).
[COPYRIGHT](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckconfig/v0.1.0/integrations/ckconfig/COPYRIGHT) |