From 8bf1c0d0e9a40c2d6e472b879b4d1e32d8b9bb89 Mon Sep 17 00:00:00 2001 From: Richard McDaniel <1130888+rmcdaniel@users.noreply.github.com> Date: Tue, 17 Nov 2026 21:52:27 +0000 Subject: [PATCH] Prepare Workflow 2.29.0 Co-Authored-By: Claude Opus 5.5 --- CHANGELOG.md | 27 +++++++++++++++++--- composer.json | 2 +- docs/business-state-machines.md | 2 +- docs/compensation-scopes.md | 6 ++--- examples/configured-state-machines/README.md | 2 +- examples/provider-state-machines/README.md | 2 +- 6 files changed, 31 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3fd856af1..2dcf078b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,24 @@ ## Unreleased +## 2.29.0 - 2026-11-17 + +**Run migrations.** Seven migrations add the compensation scope/obligation +and schedule occurrence tables, nullable `workflow_runs.timeout_cleanup_work_deadline_at`, +nullable `workflow_instances.native_child_reservation` and +`native_root_reservation`, and two MariaDB-only timestamp corrections. All are +additive and do not rewrite retained rows. The experimental APIs below (compensation +scopes, deadline-triggered cleanup, child-start receipts, entity references and +the `Workflow\V2\StateMachine` transition protocol) carry no backward-compatibility +promise yet; see `docs/api-stability.md`. + +- Experimental `Workflow\V2\StateMachine` additions (#1069): shared machine + definitions, policy profiles, recorded rule assessments, execution references + and budgets, run through native activities, children and retained + compensation. Provider integration and published-package recovery + qualification remain unfinished; there is no in-flight profile migration API. + See `docs/business-state-machines.md`. + - Replaying a resolved selection restores its recorded winner without advancing older losing signal waits. New signals remain bound to their current wait occurrence, including after an earlier selection member was cancelled. @@ -49,9 +67,6 @@ migration. Worker-protocol execution refuses the new calls. State-bound business bindings and retained compensation remain separate #1069 work. -- Require patched Laravel 12.72 or 13.41 minimums for the current Composer - security advisories. Keep existing application audits enabled and update - application lockfiles before upgrading Workflow (#1133). - Failed-run redrive preserves fractional seconds in replay clocks for the original run start and reused steps. Repeated redrive keeps previously recorded clock strings unchanged. @@ -94,6 +109,12 @@ option until their capability admission is implemented (server#1201). Bridge workers cannot claim an opted-in embedded run. Service mode follows separately. +## 2.28.1 - 2026-11-13 + +- Require patched Laravel 12.72 or 13.41 minimums for the current Composer + security advisories. Keep existing application audits enabled and update + application lockfiles before upgrading Workflow (#1133). + ## 2.28.0 - 2026-11-13 **Behavior change:** an un-awaited `select()` loser is cancelled when the run diff --git a/composer.json b/composer.json index d970e11eb..f4aa88d18 100644 --- a/composer.json +++ b/composer.json @@ -87,7 +87,7 @@ "dev-main": "2.0.x-dev" }, "durable-workflow": { - "product-train": "2.28.0", + "product-train": "2.29.0", "laravel-embedded-upgrade-contract": "resources/laravel-embedded-upgrade-contract.json", "laravel-dependency-security-policy": "resources/laravel-dependency-security-policy.json" }, diff --git a/docs/business-state-machines.md b/docs/business-state-machines.md index aa776b76c..95ffc6576 100644 --- a/docs/business-state-machines.md +++ b/docs/business-state-machines.md @@ -2,7 +2,7 @@ The optional embedded V2 transition protocol provides a four-method step contract, recorded assessments, shared machine definitions and versioned integration profiles. It uses existing native activities, children and Saga. Existing workflows and `Workflow\States\StateMachine` are unchanged. Symfony Workflow is not a dependency. -**Experimental.** The `Workflow\V2\StateMachine` API is under review and may change in a minor release; it carries no backward-compatibility promise yet. The [recorded Order/Shipment example](../examples/configured-state-machines/README.md) connects two integration profiles to retained compensation and protected SQL decisions. Optional definition and forward-execution budgets are described below. Provider integration and published-package recovery qualification remain unfinished. There is no in-flight profile migration API. These additions are not present in the published 2.28.1 package. This does not complete the proposal. +**Experimental.** The `Workflow\V2\StateMachine` API is under review and may change in a minor release; it carries no backward-compatibility promise yet. The [recorded Order/Shipment example](../examples/configured-state-machines/README.md) connects two integration profiles to retained compensation and protected SQL decisions. Optional definition and forward-execution budgets are described below. Provider integration and published-package recovery qualification remain unfinished. There is no in-flight profile migration API. These experimental additions first ship in 2.29.0. This does not complete the proposal. ## Responsibilities and flow diff --git a/docs/compensation-scopes.md b/docs/compensation-scopes.md index cb385f8ee..3b334518b 100644 --- a/docs/compensation-scopes.md +++ b/docs/compensation-scopes.md @@ -340,6 +340,6 @@ test database; SQLite does not qualify those race orderings. The example is an integration starting point for these experimental APIs. The complete StateMachine transition/rule adapter, policy migration and remaining [business state-machine criteria](https://github.com/durable-workflow/workflow/issues/1069) -are separate. These APIs are absent from the published 2.28.1 package; a supported -package, upgrade/recovery qualification and versioned consumer documentation are -still publication milestones. +are separate. These experimental APIs first ship in 2.29.0; installed upgrade/recovery +qualification and versioned consumer documentation remain milestones before +they are supported. diff --git a/examples/configured-state-machines/README.md b/examples/configured-state-machines/README.md index 3feca5db3..c7249ea15 100644 --- a/examples/configured-state-machines/README.md +++ b/examples/configured-state-machines/README.md @@ -4,7 +4,7 @@ This experimental application example composes the existing `TransitionRunner`, `ActivityTransitionRuntime`, rule registry, native child reservations and retained compensation scopes. It is a repository source example rather than an installed-package guide. The complete [business-state-machine feature](https://github.com/durable-workflow/workflow/issues/1069) -remains unfinished. The retained-scope additions are absent from published 2.28.1. +remains unfinished. The retained-scope additions first ship, experimentally, in 2.29.0. The application assigns each Order a pinned `prepare` or `imported` profile before starting its native workflow. Both profiles share the same state catalogue and diff --git a/examples/provider-state-machines/README.md b/examples/provider-state-machines/README.md index 1951d0ca8..d6f83b869 100644 --- a/examples/provider-state-machines/README.md +++ b/examples/provider-state-machines/README.md @@ -7,7 +7,7 @@ routing correction and controlled-clock fixture passed the complete source backend cycle in #1161. The common checkout policies below are a subsequent source increment. This directory remains experimental source, not an installed-package guide. -Published Workflow 2.28.1 does not contain these retained-scope or StateMachine APIs. +The retained-scope and StateMachine APIs it uses first ship, experimentally, in Workflow 2.29.0. The opt-in [original root entry](original-root.md) retains the original business intent before native admission and defines startup cancellation for the original