Prepare ckprompt v0.9.0 guidance
This commit is contained in:
23
docs/cli.md
23
docs/cli.md
@@ -666,7 +666,7 @@ request overrides. Backend reports describe configured backend fields. An
|
|||||||
`api_key_env` value names an environment variable; it is not a credential
|
`api_key_env` value names an environment variable; it is not a credential
|
||||||
value or a claim that one is available. Neither report resolves references or
|
value or a claim that one is available. Neither report resolves references or
|
||||||
performs a network probe. See the [PromptKit resource inspection
|
performs a network probe. See the [PromptKit resource inspection
|
||||||
contracts](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/resource_inspection.go).
|
contracts](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/resource_inspection.go).
|
||||||
Omitting the ID is a usage error. Configuration loading follows the
|
Omitting the ID is a usage error. Configuration loading follows the
|
||||||
[configuration failure classification](#configuration-failure-classification);
|
[configuration failure classification](#configuration-failure-classification);
|
||||||
lookup failures and cancellation are operational.
|
lookup failures and cancellation are operational.
|
||||||
@@ -722,7 +722,7 @@ text output use YAML. Preparation can read resources and include rendered
|
|||||||
application content in the report. It does not guarantee that a later model
|
application content in the report. It does not guarantee that a later model
|
||||||
call will succeed. Application loaders and callbacks may have their own
|
call will succeed. Application loaders and callbacks may have their own
|
||||||
effects. The [PromptKit Prepare
|
effects. The [PromptKit Prepare
|
||||||
API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/engine.go)
|
API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/engine.go)
|
||||||
owns the prepared value and upstream preparation behavior. Configuration failures
|
owns the prepared value and upstream preparation behavior. Configuration failures
|
||||||
follow the [configuration failure classification](#configuration-failure-classification);
|
follow the [configuration failure classification](#configuration-failure-classification);
|
||||||
other preparation failures are operational.
|
other preparation failures are operational.
|
||||||
@@ -758,8 +758,8 @@ identity rather than changing the discovered requirements. An enabled profile
|
|||||||
namespace qualifies an explicitly supplied short profile ID; it does not
|
namespace qualifies an explicitly supplied short profile ID; it does not
|
||||||
rewrite the prompt's stored default reference. Requirements inspection does
|
rewrite the prompt's stored default reference. Requirements inspection does
|
||||||
not require the selected profile to be execution-ready. See the [PromptKit
|
not require the selected profile to be execution-ready. See the [PromptKit
|
||||||
v0.21.0 consumer
|
v0.23.1 consumer
|
||||||
guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/docs/consumers/pkg-promptkit.md)
|
guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md)
|
||||||
for configuration, selection, and requirements behavior. For built-in flags
|
for configuration, selection, and requirements behavior. For built-in flags
|
||||||
other than `--llm-var`, repeating a flag uses its last value.
|
other than `--llm-var`, repeating a flag uses its last value.
|
||||||
Application-defined flags follow their own repetition rules.
|
Application-defined flags follow their own repetition rules.
|
||||||
@@ -870,7 +870,7 @@ applicable. It does not make a model call or retain a prepared execution
|
|||||||
snapshot. A successful report describes this preparation invocation; it does
|
snapshot. A successful report describes this preparation invocation; it does
|
||||||
not certify provider acceptance or guarantee later execution. See PromptKit's
|
not certify provider acceptance or guarantee later execution. See PromptKit's
|
||||||
[`Engine.ValidateRequest`
|
[`Engine.ValidateRequest`
|
||||||
API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/engine.go).
|
API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/engine.go).
|
||||||
|
|
||||||
Configuration errors returned by request construction or engine loading follow
|
Configuration errors returned by request construction or engine loading follow
|
||||||
the [configuration failure classification](#configuration-failure-classification).
|
the [configuration failure classification](#configuration-failure-classification).
|
||||||
@@ -936,8 +936,8 @@ The entries are:
|
|||||||
A catalog result is an inventory, not a readiness check or execution result.
|
A catalog result is an inventory, not a readiness check or execution result.
|
||||||
The owning provider controls membership and order. Namespace filters are
|
The owning provider controls membership and order. Namespace filters are
|
||||||
passed to PromptKit without local membership interpretation. See the
|
passed to PromptKit without local membership interpretation. See the
|
||||||
[PromptKit v0.21.0 consumer
|
[PromptKit v0.23.1 consumer
|
||||||
guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/docs/consumers/pkg-promptkit.md)
|
guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md)
|
||||||
for resource and selection definitions. Catalog loading failures follow the
|
for resource and selection definitions. Catalog loading failures follow the
|
||||||
[configuration failure classification](#configuration-failure-classification).
|
[configuration failure classification](#configuration-failure-classification).
|
||||||
|
|
||||||
@@ -1108,9 +1108,9 @@ separately from delivery failures through the [reporting
|
|||||||
API](consumers/guide.md#invocation-reporting).
|
API](consumers/guide.md#invocation-reporting).
|
||||||
|
|
||||||
Native configuration, selection, and diagnostic meanings remain owned by
|
Native configuration, selection, and diagnostic meanings remain owned by
|
||||||
PromptKit. See the [v0.21.0 consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/docs/consumers/pkg-promptkit.md),
|
PromptKit. See the [v0.23.1 consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md),
|
||||||
[smoke API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/smoke_diagnostics.go),
|
[smoke API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/smoke_diagnostics.go),
|
||||||
and [engine API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/engine.go).
|
and [engine API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/engine.go).
|
||||||
|
|
||||||
## Outcome status
|
## Outcome status
|
||||||
|
|
||||||
@@ -1133,6 +1133,9 @@ failing branches selects status `2` only when every branch identifies invalid
|
|||||||
input; cancellation or a deadline always selects status `1`. Existing source
|
input; cancellation or a deadline always selects status `1`. Existing source
|
||||||
and validation reports can still be delivered after a failed load. Filters on
|
and validation reports can still be delivered after a failed load. Filters on
|
||||||
validation details do not change classification.
|
validation details do not change classification.
|
||||||
|
With the current ckprompt candidate, malformed PromptKit companion YAML from
|
||||||
|
engine construction follows this same classification, with available diagnostics
|
||||||
|
and typed causes retained.
|
||||||
|
|
||||||
Applications may define additional results and decide how CommandKit's status
|
Applications may define additional results and decide how CommandKit's status
|
||||||
maps to the process exit code. A command's successful status does not replace
|
maps to the process exit code. A command's successful status does not replace
|
||||||
|
|||||||
@@ -24,6 +24,9 @@ v0.21.0.
|
|||||||
| PromptKit integration | v0.6.0 | v0.8.0 | v0.8.0 | ConfigKit v1.2.0 and PromptKit v0.21.0. |
|
| PromptKit integration | v0.6.0 | v0.8.0 | v0.8.0 | ConfigKit v1.2.0 and PromptKit v0.21.0. |
|
||||||
| Earlier matched integration set | v0.3.0 | v0.2.0 | v0.2.0 | ConfigKit v0.8.0 and PromptKit v0.16.0, using their earlier import paths. |
|
| Earlier matched integration set | v0.3.0 | v0.2.0 | v0.2.0 | ConfigKit v0.8.0 and PromptKit v0.16.0, using their earlier import paths. |
|
||||||
|
|
||||||
|
The prepared ckprompt v0.9.0 candidate selects core v0.6.0, ckconfig v0.8.0,
|
||||||
|
ConfigKit v1.2.0, and PromptKit v0.23.1. It is not yet published.
|
||||||
|
|
||||||
Install the published core with:
|
Install the published core with:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -44,9 +47,10 @@ loaders should use keyed struct literals when constructing them. ConfigKit's
|
|||||||
release notes describe
|
release notes describe
|
||||||
main-relative imports and overlay contexts. [ConfigKit v1.2.0 upgrade guidance](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.2.0/docs/releases/v1.2.0.md#upgrade-notes).
|
main-relative imports and overlay contexts. [ConfigKit v1.2.0 upgrade guidance](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.2.0/docs/releases/v1.2.0.md#upgrade-notes).
|
||||||
|
|
||||||
PromptKit v0.21.0 exposes main-relative companion imports through its existing
|
The current checkout selects PromptKit v0.23.1, which exposes main-relative
|
||||||
configuration-source API. Applications select those inputs when constructing
|
companion imports through its existing configuration-source API. Applications
|
||||||
the engine supplied to ckprompt's loader callback. [PromptKit companion import guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/docs/consumers/pkg-promptkit.md#load-companion-prompts-relative-to-the-main-configuration).
|
select those inputs when constructing
|
||||||
|
the engine supplied to ckprompt's loader callback. [PromptKit companion import guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md#load-companion-prompts-relative-to-the-main-configuration).
|
||||||
|
|
||||||
Importing a module does not install its commands. Pass commands to
|
Importing a module does not install its commands. Pass commands to
|
||||||
`commandkit.New` or `App.Register` explicitly. ckprompt depends on ckconfig's
|
`commandkit.New` or `App.Register` explicitly. ckprompt depends on ckconfig's
|
||||||
@@ -415,6 +419,12 @@ and state. `FromEngine` uses PromptKit's public listing and inspection methods,
|
|||||||
including `Engine.InspectRequirements`; validation must be opted into separately
|
including `Engine.InspectRequirements`; validation must be opted into separately
|
||||||
and uses `Engine.ValidateRequest`.
|
and uses `Engine.ValidateRequest`.
|
||||||
|
|
||||||
|
Applications own engine construction and may build complete native requests in
|
||||||
|
callbacks. Preparation and validation use the supplied context; execution owns
|
||||||
|
prepared notifications and operation timeouts. See the [PromptKit consumer
|
||||||
|
guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md)
|
||||||
|
for conversation and execution capabilities.
|
||||||
|
|
||||||
`ckprompt.WithRequestPreparation` adds a separate callback backed by
|
`ckprompt.WithRequestPreparation` adds a separate callback backed by
|
||||||
`Engine.Prepare`. Its optional builder receives the seeded request and returns
|
`Engine.Prepare`. Its optional builder receives the seeded request and returns
|
||||||
the complete request to prepare. The resulting native report can contain
|
the complete request to prepare. The resulting native report can contain
|
||||||
@@ -475,7 +485,7 @@ These are independent defaults for unqualified caller-supplied prompt, profile,
|
|||||||
and backend names; qualified IDs pass through. Stored references and configuration
|
and backend names; qualified IDs pass through. Stored references and configuration
|
||||||
inspection are unchanged, while namespace and collection inventories remain global.
|
inspection are unchanged, while namespace and collection inventories remain global.
|
||||||
Catalog `--namespace` filters are separate from these defaults. See the released
|
Catalog `--namespace` filters are separate from these defaults. See the released
|
||||||
[namespace API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/namespaces.go).
|
[namespace API](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/namespaces.go).
|
||||||
|
|
||||||
## Outcomes and ownership
|
## Outcomes and ownership
|
||||||
|
|
||||||
@@ -490,7 +500,7 @@ Go declarations and GoDoc own exact exported contracts. ConfigKit owns
|
|||||||
configuration decoding, validation, and provenance. PromptKit owns prompt
|
configuration decoding, validation, and provenance. PromptKit owns prompt
|
||||||
formats, profile resolution, and inspection details. See the
|
formats, profile resolution, and inspection details. See the
|
||||||
[ConfigKit v1.2.0 source records](https://forge.maximumdirect.net/base-layer/configkit/src/commit/c1c7e87f2cdf77a0cbf3327831ac05578e756b9e/records.go),
|
[ConfigKit v1.2.0 source records](https://forge.maximumdirect.net/base-layer/configkit/src/commit/c1c7e87f2cdf77a0cbf3327831ac05578e756b9e/records.go),
|
||||||
[PromptKit engine methods](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/engine.go),
|
[PromptKit engine methods](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/engine.go),
|
||||||
[configuration inspection](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/configuration_inspection.go),
|
[configuration inspection](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/configuration_inspection.go),
|
||||||
[smoke diagnostics](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/smoke_diagnostics.go),
|
[smoke diagnostics](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/smoke_diagnostics.go),
|
||||||
and [PromptKit v0.21.0 consumer guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/171fb11f4e967a1da3af57843c6467954b14ba09/docs/consumers/pkg-promptkit.md).
|
and [PromptKit v0.23.1 consumer guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/consumers/pkg-promptkit.md).
|
||||||
|
|||||||
@@ -184,7 +184,12 @@ causes, native prepared-report forwarding, and the passing independent suite.
|
|||||||
|
|
||||||
## Stage 4 — Update current guidance and prepare ckprompt v0.9.0
|
## Stage 4 — Update current guidance and prepare ckprompt v0.9.0
|
||||||
|
|
||||||
Status — pending.
|
Status — completed. Consumer and CLI guidance identifies the prepared v0.9.0
|
||||||
|
candidate separately from published v0.8.0, links to PromptKit v0.23.1, and
|
||||||
|
describes construction, request ownership, and the corrected outcome. The
|
||||||
|
version-matched release note records compatibility and includes full-tag notice
|
||||||
|
links. Upstream source paths and relevant fragments were checked against the
|
||||||
|
selected module; ckprompt GoDoc required no version-specific correction.
|
||||||
|
|
||||||
1. Update PromptKit references in `docs/consumers/guide.md` and `docs/cli.md`
|
1. Update PromptKit references in `docs/consumers/guide.md` and `docs/cli.md`
|
||||||
to the selected source revision. Verify destinations and fragments against
|
to the selected source revision. Verify destinations and fragments against
|
||||||
|
|||||||
26
integrations/ckprompt/docs/releases/v0.9.0.md
Normal file
26
integrations/ckprompt/docs/releases/v0.9.0.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# CommandKit ckprompt v0.9.0
|
||||||
|
|
||||||
|
This candidate upgrades PromptKit from v0.21.0 to v0.23.1. PromptKit's
|
||||||
|
constructor now preserves configuration causes without treating its category
|
||||||
|
sentinel as a separate failure.
|
||||||
|
|
||||||
|
## Compatibility and upgrade
|
||||||
|
|
||||||
|
Malformed PromptKit companion YAML returned by engine construction now selects
|
||||||
|
status `2` instead of `1`. Update scripts that interpret this status. Available
|
||||||
|
source and validation reports, diagnostics, typed ConfigKit causes, and
|
||||||
|
`promptkit.ErrInvalidConfig` recognition are retained. Operational failures and
|
||||||
|
cancellation continue to select status `1`. See the [configuration failure
|
||||||
|
contract](../../../../docs/cli.md#configuration-failure-classification).
|
||||||
|
|
||||||
|
Pair ckprompt v0.9.0 with ckconfig v0.8.0 and CommandKit core v0.6.0. The
|
||||||
|
selected upstream versions are ConfigKit v1.2.0 and PromptKit v0.23.1; the Go
|
||||||
|
consumer minimum remains 1.27.0. Native request builders continue to pass the
|
||||||
|
whole PromptKit request, including additive fields, and prepared reports carry
|
||||||
|
upstream fields such as parent run identifiers. Applications own construction
|
||||||
|
of engines and requests. See the [consumer guide](../../../../docs/consumers/guide.md#promptkit-configuration-definitions-and-requirements)
|
||||||
|
and [upstream upgrade guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/releases/v0.23.1.md#compatibility-and-upgrade).
|
||||||
|
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.9.0/integrations/ckprompt/COPYRIGHT) |
|
||||||
|
[LICENSE](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.9.0/integrations/ckprompt/LICENSE) |
|
||||||
|
[ATTRIBUTION](https://forge.maximumdirect.net/base-layer/commandkit/src/tag/integrations/ckprompt/v0.9.0/integrations/ckprompt/docs/oss/attribution.md)
|
||||||
Reference in New Issue
Block a user