Skip to content

Commit 8e4c268

Browse files
Remove server 0.x references from compatibility matrix
Updated to reflect that CLI 0.1.x and Python SDK 0.1.x require server 2.x only. Removed prerelease version history. Part of #271
1 parent 54cd59f commit 8e4c268

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

docs/compatibility.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This page documents version compatibility across Durable Workflow components. Al
1313
| Component | Current Version | Notes |
1414
|-----------|----------------|-------|
1515
| Workflow Package (PHP) | 1.0.75 (v1), 2.0.0 (v2) | Core workflow engine |
16-
| Standalone Server | 0.1.0 - 0.1.9, 2.0.0 | Language-neutral HTTP server |
16+
| Standalone Server | 2.0.0 | Language-neutral HTTP server |
1717
| CLI | 0.1.0 | Command-line interface |
1818
| Python SDK | 0.1.0 | Python client and worker |
1919
| Waterline | 1.0.16 (v1), 2.0.0 (v2) | Observability UI |
@@ -24,14 +24,11 @@ This page documents version compatibility across Durable Workflow components. Al
2424

2525
| Server Version | CLI 0.1.x | Python SDK 0.1.x | PHP Workflow 2.0.x |
2626
|----------------|-----------|------------------|-------------------|
27-
| 0.1.x (prerelease) | ✅ Compatible | ✅ Compatible | ✅ Compatible |
2827
| 2.0.x (stable) | ✅ Compatible | ✅ Compatible | ✅ Compatible |
2928
| 1.x | ❌ Skipped | ❌ Skipped | ❌ Skipped |
3029
| 3.x+ (future) | ❌ Breaking | ❌ Breaking | ❌ Breaking |
3130

32-
**Version 1.x**: Intentionally skipped. The project moved from 0.x (prerelease) directly to 2.x (stable).
33-
34-
**Why 0.x and 2.x are compatible**: The 0.1.x server releases were pre-release versions of what became 2.0. The protocol and API shape remained stable across this transition, so clients written for 0.1.x work with 2.0.x without changes.
31+
**Version 1.x**: Intentionally skipped. The project moved directly to 2.x (stable).
3532

3633
### Workflow Package ↔ Waterline
3734

@@ -50,7 +47,7 @@ The CLI validates server version on first invocation per session:
5047

5148
```bash
5249
$ dw server:health
53-
Server version 3.0.0 is incompatible with dw CLI 0.1.x (requires server 0.x or 2.x).
50+
Server version 3.0.0 is incompatible with dw CLI 0.1.x (requires server 2.x).
5451
Upgrade the server or use a compatible CLI version.
5552
```
5653

@@ -73,7 +70,7 @@ If incompatible:
7370

7471
```
7572
RuntimeError: Server version 3.0.0 is incompatible with sdk-python 0.1.x
76-
(requires server 0.x or 2.x). Upgrade the server or use a compatible SDK version.
73+
(requires server 2.x). Upgrade the server or use a compatible SDK version.
7774
```
7875

7976
### Server
@@ -104,7 +101,7 @@ Minor versions are backward-compatible within the same major version:
104101

105102
Example: Server 2.0.1 works with CLI 0.1.0 and Python SDK 0.1.0.
106103

107-
### Major Version Upgrades (0.x → 2.x, 2.x → 3.x)
104+
### Major Version Upgrades (2.x → 3.x)
108105

109106
Major version changes may introduce breaking changes:
110107

@@ -113,8 +110,6 @@ Major version changes may introduce breaking changes:
113110
3. **Validate with one client**: Test one CLI command or SDK worker
114111
4. **Upgrade remaining clients**: CLI, SDK, workers
115112

116-
**Pre-release to stable (0.1.x → 2.0.x)**: This upgrade is backward-compatible. Clients written for 0.1.x work with 2.0.x without code changes.
117-
118113
**Future major versions (2.x → 3.x)**: Will require client updates. Version validation will catch incompatibilities and provide clear error messages.
119114

120115
## Version Negotiation Protocol
@@ -142,7 +137,7 @@ The server validates these headers and rejects requests with missing or incompat
142137
**Fix**:
143138
1. Check the compatibility matrix above
144139
2. Upgrade server or client to compatible versions
145-
3. If server is 0.x or 2.x and client reports incompatibility, file a bug
140+
3. If server is 2.x and client reports incompatibility, file a bug
146141

147142
### "Missing X-Durable-Workflow-Protocol-Version header"
148143

@@ -154,16 +149,13 @@ The server validates these headers and rejects requests with missing or incompat
154149

155150
**Cause**: Server and client disagree on control-plane protocol version.
156151

157-
**Fix**: Ensure server is 0.1.x or 2.x and client is sending version 2 header.
152+
**Fix**: Ensure server is 2.x and client is sending version 2 header.
158153

159154
## Version History
160155

161156
| Date | Server | CLI | Python SDK | Workflow | Waterline | Notes |
162157
|------|--------|-----|------------|----------|-----------|-------|
163158
| 2026-04-15 | 2.0.0 | 0.1.0 | 0.1.0 | 2.0.0 | 2.0.0 | Stable release |
164-
| 2026-04-12 | 0.1.9 | 0.1.0 | 0.1.0 | 2.0.0-alpha.2 | 2.0.0-alpha | Pre-release |
165-
| 2026-04-01 | 0.1.8 | 0.1.0 | 0.1.0 | 2.0.0-alpha.1 | 2.0.0-alpha | Pre-release |
166-
| 2026-03-15 | 0.1.7 | 0.1.0 | - | 1.0.75 | 1.0.16 | Python SDK not yet released |
167159

168160
## See Also
169161

0 commit comments

Comments
 (0)