Document shared loading and integration upgrades
This commit is contained in:
@@ -8,6 +8,10 @@
|
||||
// these with commandkit.New or App.Register.
|
||||
//
|
||||
// ConfigScope separately exposes engine configuration through ckconfig.
|
||||
// ConfigScope preserves PromptKit focused discovery and whole-load evidence.
|
||||
// Applications can compose PromptKit settings into an application-owned load
|
||||
// and pass the completed result to promptkit.NewFromConfig.
|
||||
//
|
||||
// Importing this package installs neither command family. Applications own
|
||||
// engine construction, credentials, and client configuration.
|
||||
package ckprompt
|
||||
|
||||
40
integrations/ckprompt/docs/releases/v0.11.0.md
Normal file
40
integrations/ckprompt/docs/releases/v0.11.0.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# CommandKit ckprompt v0.11.0
|
||||
|
||||
Candidate note; publication is pending.
|
||||
|
||||
CommandKit ckprompt v0.11.0 adopts PromptKit v0.24.0 and ConfigKit v1.4.0.
|
||||
It supports application-owned shared configuration loading and exposes native
|
||||
focused PromptKit inspection. Core remains v0.7.0 and the consumer minimum
|
||||
remains Go 1.27.0.
|
||||
|
||||
## Compatibility and upgrade
|
||||
|
||||
Pair this release with the coordinated ckconfig release. Complete PromptKit
|
||||
configuration documents now place settings under `promptkit`; mount wrapperless
|
||||
settings with `SettingsInput` and collection fragments with `CollectionInput`.
|
||||
Discovery inputs for fragments need an explicit destination. Resource IDs do
|
||||
not gain a prefix, but configuration paths now use native locations such as
|
||||
`/promptkit/profiles/0/model`. Focused listings use native paths; explicit
|
||||
queries, sources, diagnostics, and comparison retain whole-load context.
|
||||
|
||||
PromptKit removed `Config.SchemaDir`, `WithSchemaFS`, and `WithSchemaFile`.
|
||||
Use supported inline, source-relative, or explicit-root schema selection.
|
||||
Request builders replace validation with `*promptkit.OutputContractInput`;
|
||||
its pointer repair budget distinguishes omission from explicit zero. Resolved
|
||||
reports include the budget, including zero, and prompt reports include native
|
||||
schema selections. The default enables one repair for eligible modes, which
|
||||
can add a generation call, latency, and usage. Applications own resource-version
|
||||
policy and sensitivity of their extension fields.
|
||||
|
||||
Prepared reports now include `message_content_hash` and native schema evidence.
|
||||
Migrate positional `PreparedRun` literals to keyed fields; older JSON without
|
||||
the hash decodes with an empty hash. See the [PromptKit migration guide](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.24.0/docs/consumers/configuration-migration.md),
|
||||
[format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.24.0/docs/formats.md),
|
||||
and [release notes](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.24.0/docs/releases/v0.24.0.md)
|
||||
for the upstream contract. PromptKit v0.23.3's timeout and cancellation identity
|
||||
corrections are included. The [consumer guide](../../../../docs/consumers/guide.md#promptkit-configuration-definitions-and-requirements)
|
||||
links the maintained shared-load example.
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.11.0/integrations/ckprompt/COPYRIGHT) |
|
||||
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.11.0/integrations/ckprompt/LICENSE) |
|
||||
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.11.0/integrations/ckprompt/docs/oss/attribution.md)
|
||||
@@ -6,8 +6,8 @@ in-memory model client. **No model service or credentials are required.**
|
||||
|
||||
Use Go 1.27.0 on `PATH`. An aligned workspace containing all three local modules
|
||||
exercises their current sources; follow the [workspace setup](../../../../docs/development.md#documentation-validation)
|
||||
from the repository root. The example also builds independently with
|
||||
`GOWORK=off` against its module's released dependencies.
|
||||
from the repository root. The current checkout requires the local ckconfig API;
|
||||
its published v0.9.0 dependency does not yet provide that API.
|
||||
The [consumer guide](../../../../docs/consumers/guide.md#module-selection) owns
|
||||
version and compatibility details.
|
||||
|
||||
@@ -21,7 +21,7 @@ go run . promptkit list prompts --campaign spring
|
||||
go run . promptkit show prompt briefing --campaign spring --format yaml
|
||||
```
|
||||
|
||||
The first command lists `app` and `promptkit` configurations and their available
|
||||
The first command lists `app`, `storage`, and `promptkit` configurations and their available
|
||||
operations. The next commands find and inspect the `briefing` prompt.
|
||||
`--campaign` is a selector supplied by this example, not a standard PromptKit flag.
|
||||
|
||||
@@ -30,6 +30,8 @@ operations. The next commands find and inspect the `briefing` prompt.
|
||||
```sh
|
||||
go run . config validate --scope all --campaign spring --limit=0
|
||||
go run . config diff --scope app --config fixtures/before.yml --against-config fixtures/after.yml
|
||||
go run . config show --scope storage --config fixtures/before.yml
|
||||
go run . config diff --scope storage --config fixtures/before.yml --against-config fixtures/after.yml
|
||||
go run . config diff --scope promptkit --config fixtures/before.yml --against-config fixtures/after.yml --campaign spring --against-campaign spring
|
||||
```
|
||||
|
||||
@@ -44,8 +46,8 @@ The two sides have independent selectors and overrides:
|
||||
go run . config diff --scope app --campaign spring --limit=0 --against-campaign autumn --against-limit=0 --set '/campaigns/spring/model="left"' --against-set '/campaigns/spring/model="right"' --details
|
||||
```
|
||||
|
||||
Only the application scope supports `--set` here. The released PromptKit loader
|
||||
has no override handoff, so its configuration scope does not enable the feature.
|
||||
The application and storage scopes support `--set` here. The PromptKit scope
|
||||
does not advertise override support in this example.
|
||||
An aggregate operation that includes that scope rejects overrides.
|
||||
|
||||
## List resources and select namespaces
|
||||
@@ -155,7 +157,9 @@ selects the command context without loading an engine.
|
||||
The example installs `ckconfig.Command(suite)` and
|
||||
`ckprompt.Declarations(definitions)` with application-owned aliases in a
|
||||
`[]commandkit.Declaration`. `NewInput` initializes scope inputs; `NewState`
|
||||
creates a cache shared within an invocation. The loaders cache successful
|
||||
creates a cache shared within an invocation. The application composes PromptKit
|
||||
settings and resources into its ConfigKit load; the engine consumes the same
|
||||
result, and `FromConfigKitSubtree` exposes `storage`. The loaders cache successful
|
||||
configuration results by the complete configuration/overlay selection,
|
||||
overrides, and supplied campaign, including whether each value was supplied.
|
||||
These are example choices, not a CommandKit cache policy.
|
||||
@@ -167,5 +171,5 @@ for suite composition, builders, and ownership, and the [source](main.go) for
|
||||
the complete application.
|
||||
|
||||
Run `GOWORK=auto GOTOOLCHAIN=local go test ./...` from this example directory
|
||||
for an aligned workspace check. Use
|
||||
`GOWORK=off GOTOOLCHAIN=local go test ./...` to check the declared releases.
|
||||
for an aligned workspace check. Independent ckprompt validation against its
|
||||
declared requirements follows the coordinated ckconfig release.
|
||||
|
||||
Reference in New Issue
Block a user