Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/release-notes/2.10.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Durable Workflow CLI 2.10.0

## See which open runs still depend on a version branch

2.10.0 adds `dw workflow:version-usage` (cli#158, durable-workflow/.github#220).
Before you raise a minimum supported version or delete a `patched()` legacy
branch, ask the Server which open runs would still replay through it:

```bash
dw workflow:version-usage orders.Checkout payment-provider --min-version=2
dw workflow:version-usage orders.Checkout payment-provider --min-version=2 --state=unknown --json
```

- **Each open run is legacy, current or unknown.** Legacy means it recorded a
version below `--min-version`; current means at or above. Unknown means it
has no marker for this change ID (`marker_absent`) or its history is
unavailable or invalid. A run that started before the change point existed
shows as unknown, so retire a branch only when legacy **and** unknown are zero.
- **Counts cover every open run**, before `--state` filtering and paging. Closed
runs are not included. Markers recorded by the PHP, Python and Rust SDKs and by
embedded Laravel classify the same way.
- **Paging.** `--limit` (1–200) sets the page size. Pass the returned opaque
`next_cursor` with the same query to continue. JSON and JSONL output keep the
whole page, including counts.
- **It needs Server 3.12.0 or later.** The command checks that the Server
advertises `capabilities.workflow_version_usage`. If it doesn't, the command
exits with code 8 before sending the query and never reports an empty result.

The result is a live view, not a deployment fence. Stop or fence new starts
that could take the old path, then run the query again before removing code.
See [Check Open Runs Before Retiring a Branch](https://durable-workflow.com/docs/features/versioning/#check-version-usage).

## The development Server is now Server 3.12.0

`dw server:start-dev` now embeds native Server **3.12.0** (cli#165), so the
local Server answers `workflow:version-usage` and includes the 3.12.0
retained-payload fixes.

**Existing development data is upgraded once.** The first time 2.10.0 starts on
a data directory created by 2.9.0, it upgrades that SQLite database from schema
14 to 15 in place. It prints `Upgraded the development database from schema 14
to 15.`, keeps your workflows and history, and then starts normally. The upgrade:

- runs only on the development Server's own data directory, while it holds that
directory exclusively;
- is a single transaction, so an interrupted upgrade leaves the database as it
was;
- is **one-way**: CLI 2.9.0 can no longer open that directory afterwards. To keep
a copy usable by 2.9.0, copy the data directory (by default `dev-server` beside
the CLI config file) before the first 2.10.0 start.

A data directory written by a newer `dw` is still refused, and the message says
to use that newer `dw` or to choose another `--data-dir`.

## Compatibility

- Commands other than `workflow:version-usage` work with the same Servers as
2.9.0.
- The CLI still uses the published Rust SDK 4.18.0. Building from source needs
Rust 1.99.
2 changes: 1 addition & 1 deletion rust/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rust/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "dw"
version = "2.9.0"
version = "2.10.0"
edition = "2021"
rust-version = "1.99"
description = "Command-line interface for Durable Workflow Server and Cloud"
Expand Down
Loading