diff --git a/docs/consumers/guide.md b/docs/consumers/guide.md index d0caac6..fee2159 100644 --- a/docs/consumers/guide.md +++ b/docs/consumers/guide.md @@ -26,6 +26,9 @@ v0.21.0. 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. +For applications moving from ckprompt v0.8.0, the +[v0.9.0 upgrade notes](../../integrations/ckprompt/docs/releases/v0.9.0.md#compatibility-and-upgrade) +cover migration of positional literals for affected native PromptKit structs. Install the published core with: diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index f9a088d..45eb873 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -10,7 +10,7 @@ in the [adoption snapshot](https://forge.maximumdirect.net/base-layer/commandkit Stage 1 selects the intended published dependency and attribution revision. Stages 2 and 3 exercise real constructor failures, preserve error identity and diagnostics, retain operational/cancellation precedence, and forward native -prepared-report fields. Stage 4 has the upgrade-guidance gap below. Stage 5 +prepared-report fields. Stage 4's upgrade-guidance gap is resolved below. Stage 5 retired the completed records with resolution evidence retained in Git history. Verification used Go 1.27.0 and included the focused constructor/preparation @@ -22,7 +22,11 @@ paths/fragments, and future release-note notice paths were also checked. ## R1 — Explain the positional-literal migration in upgrade guidance -Status — open. +Status — completed. The ckprompt v0.9.0 note now explains the conditional +positional-to-keyed literal migration and links the intervening PromptKit +v0.22.0 and v0.23.0 compatibility guidance. The consumer guide points candidate +users to that upgrade note. Local links, upstream compatibility fragments, +and whitespace checks passed against the selected source. Priority — medium, release-preparation documentation. diff --git a/integrations/ckprompt/docs/releases/v0.9.0.md b/integrations/ckprompt/docs/releases/v0.9.0.md index e45e690..bb38fc5 100644 --- a/integrations/ckprompt/docs/releases/v0.9.0.md +++ b/integrations/ckprompt/docs/releases/v0.9.0.md @@ -21,6 +21,12 @@ 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). +PromptKit v0.22.0 and v0.23.0 added fields to exported request, prepared, +result, and observation structs. If your application constructs affected types +with positional literals, migrate those literals to keyed fields when upgrading +from v0.21.0. See [PromptKit v0.22.0 compatibility](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/releases/v0.22.0.md#efficiency-and-compatibility) +and [PromptKit v0.23.0 upgrade guidance](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/74066167942fcf6f70c112359995739ec9789fa6/docs/releases/v0.23.0.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)