Document catalog profile compatibility

This commit is contained in:
2026-09-22 12:31:50 +00:00
parent 2356f7c73d
commit 6ce54c1d79
8 changed files with 120 additions and 42 deletions

33
docs/releases/v0.10.0.md Normal file
View File

@@ -0,0 +1,33 @@
# Promptkit v0.10.0 (Unreleased)
This supplemental transition guide describes the planned `v0.10.0` catalog
profile-policy change. It is not a release record and does not claim that the
version has been published. The annotated tag, when created, remains the
authoritative release record.
## Transition Summary
`v0.10.0` adopts independently versioned OpenRouter and Rakestrawhome catalog
modules whose external profile data can change between catalog releases. It
also introduces the maintained literal names
`promptkit-openrouter-standard` and `promptkit-openrouter-auto`.
The maintained names provide continuity only within the catalog versions
selected and tested by a Promptkit release and when consumers do not override
the name or its base. Their current selections may change. External catalog
profile IDs can be removed, renamed, or modified, so an application that
selects one directly may need to update its configuration when upgrading.
## Consumer Migration
Before upgrading, review every profile ID used by prompts, requests, and
application-owned inheritance. Choose a maintained name, accept an external
catalog profile's volatility, or define a complete application-owned profile
when the application must control its target and settings. An alias that
inherits from an external base is not a frozen copy.
See the [release policy](../release.md#catalog-profile-compatibility) for the
compatibility boundary, the [format reference](../formats.md#built-in-profile-catalog)
for current Promptkit-owned definitions and selected external inventories, and
the [consumer guide](../consumers/pkg-promptkit.md#choose-a-profile-ownership-model)
for configuration choices.