diff --git a/README.md b/README.md index ea08acf..9e65fe7 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,10 @@ boundary and constraints that framework work must preserve. ## Release Guidance +The [v0.23.1 release notes](docs/releases/v0.23.1.md) cover corrected constructor +error wrapping for downstream classification, with loading diagnostics and +underlying causes preserved. + The [v0.23.0 release notes](docs/releases/v0.23.0.md) cover per-operation timeouts and opt-in prepared-request notifications for ordinary and coordinated execution. diff --git a/docs/releases/v0.23.1.md b/docs/releases/v0.23.1.md new file mode 100644 index 0000000..bd12e9c --- /dev/null +++ b/docs/releases/v0.23.1.md @@ -0,0 +1,33 @@ +# Promptkit v0.23.1 + +This patch release fixes construction-error wrapping so downstream consumers +can classify failures from their underlying causes without treating the +`ErrInvalidConfig` category as an independent failure. + +## Fixed + +`NewEngine` now uses single-cause wrapping for both configuration-loading and +option-application failures. `errors.Is` still recognizes `ErrInvalidConfig`, +and `errors.As` still exposes ConfigKit loading errors with their diagnostics +and source context. Genuine joined causes, including cancellation, remain +inspectable. Consumers retain responsibility for mapping those failures to +application outcomes or exit statuses. + +See the [constructor GoDoc](../../engine.go) and +[error-handling guide](../consumers/pkg-promptkit.md#handle-errors) for the +public error contracts and usage. + +## Compatibility And Upgrade + +No configuration or request changes are required when upgrading from v0.23.0. +Consumers that inspect constructor error trees directly should account for +the category no longer appearing as a separate sibling branch; use +`errors.Is` and `errors.As` for category and typed-cause inspection. + +The Go consumer minimum remains 1.27.0, and dependency versions are unchanged. + +```sh +go get go.maximumdirect.net/promptkit@v0.23.1 +``` + +[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.23.1/COPYRIGHT) | [LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.23.1/LICENSE) | [ATTRIBUTION](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.23.1/docs/oss/attribution.md)