Prepare core and integration release notes
This commit is contained in:
@@ -1,28 +1,57 @@
|
||||
# CommandKit ckprompt v0.1.0
|
||||
|
||||
Initial independently versioned release of the optional PromptKit integration.
|
||||
It adapts PromptKit engine configuration and native comparison to
|
||||
`ckconfig.Scope`, and supplies core command declarations for prompt/profile
|
||||
catalogs and named inspection. Applications install these declarations
|
||||
explicitly.
|
||||
## 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. `ckprompt` depends on the
|
||||
separately versioned `ckconfig` module for configuration scope contracts.
|
||||
The initial independently versioned PromptKit integration exposes native
|
||||
configuration inspection and comparison, definition inspection, requirements,
|
||||
catalogs, and smoke testing. This source-only Go module uses CommandKit v0.2.0,
|
||||
ckconfig v0.1.0, PromptKit v0.16.0, and ConfigKit v0.8.0.
|
||||
|
||||
PromptKit v0.14.0 provides the engine-scope comparison used by
|
||||
`config diff --scope promptkit`. `FromEngine` supplies prompt/profile catalog and
|
||||
named-inspection callbacks, so `Command` includes the corresponding `list` and
|
||||
`show` commands. Applications can clear callbacks before command capture to
|
||||
narrow those groups. Catalogs preserve PromptKit's native identities and render
|
||||
as YAML. The [CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/branch/main/docs/cli.md)
|
||||
owns the current command and report contracts.
|
||||
## Features
|
||||
|
||||
The ConfigKit adapter is provided by `ckconfig`, which adopts ConfigKit v0.7.1
|
||||
and supplies paired comparison through the existing `config diff` family.
|
||||
- `ckprompt.ConfigScope` exposes PromptKit engine configuration and native
|
||||
comparison through the `config` family, including `config diff --scope promptkit`.
|
||||
- `ckprompt.Command` installs independently optional capabilities. `FromEngine`
|
||||
supplies named prompt/profile inspection, requirements discovery, and five
|
||||
catalogs: prompts, profiles, backends, namespaces, and collections.
|
||||
- `promptkit list` reports native inventories as YAML, with namespace filters
|
||||
for prompts, profiles, and backends, and kind filters for namespace discovery.
|
||||
- `promptkit requirements show PROMPT_ID` reports PromptKit's native input and
|
||||
variable requirements, completeness, and issues with optional caller context.
|
||||
- Opt-in `WithRequestValidation` adds
|
||||
`promptkit requirements validate PROMPT_ID`, forwarding variables and
|
||||
file-backed inputs to PromptKit's native request preparation and returning a
|
||||
YAML success confirmation.
|
||||
- Opt-in `WithSmokeTesting` adds `promptkit test KIND`, exposing native
|
||||
`reachability`, `authentication`, `text_inference`, and `structured_output`
|
||||
checks. `promptkit test all` runs those checks sequentially, continues after
|
||||
individual errors, stops on cancellation, and retains acquired reports and
|
||||
operation errors. Native observations are projected into YAML without an
|
||||
additional readiness classification.
|
||||
- Validation and smoke adapters accept optional typed request builders;
|
||||
applications retain configuration, client, and request-construction ownership.
|
||||
|
||||
See the [module README](../../README.md), [consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/docs/consumers/guide.md),
|
||||
## Requirements and adoption
|
||||
|
||||
**Go 1.26.0 or newer is required.** Add
|
||||
`gitea.maximumdirect.net/eric/CommandKit/integrations/ckprompt@v0.1.0` and
|
||||
explicitly install the desired declarations. Adding a PromptKit configuration
|
||||
scope and installing the `promptkit` family remain separate choices. Request
|
||||
validation and smoke testing each require explicit opt-in.
|
||||
|
||||
Applications migrating from CommandKit v0.1.0 must move to the separate
|
||||
integration modules and update loader, callback, and installation wiring for
|
||||
the captured declaration API. Align engine loading and fixtures with PromptKit
|
||||
v0.16.0's direct prompt definitions and collection configuration.
|
||||
|
||||
Prompt selection now uses an ID only: remove `--version` from prompt inspection
|
||||
invocations. YAML prompt inspection uses optional `version` in place of
|
||||
`prompt_version`; update report consumers accordingly. Prompt and collection
|
||||
catalogs also report optional descriptive versions, omitting the field when
|
||||
absent. PromptKit owns selection, requirements, validation, and smoke semantics.
|
||||
|
||||
See the [module README](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/README.md),
|
||||
[consumer guide](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/docs/consumers/guide.md),
|
||||
and [CLI reference](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/docs/cli.md).
|
||||
|
||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/CommandKit/src/tag/integrations/ckprompt/v0.1.0/integrations/ckprompt/COPYRIGHT) |
|
||||
|
||||
Reference in New Issue
Block a user