deploy: 54cd59f

Author: github-actions[bot]

2.0/llms-full.txt

@@ -10462,3 +10462,171 @@ dw task-queue:describe default
 
 See the [CLI repository README](https://github.com/durable-workflow/cli#commands) for the full command reference.
 
+# Version Compatibility
+
+This page documents version compatibility across Durable Workflow components. All components validate version compatibility at runtime and provide clear error messages when incompatible versions are detected.
+
+## Component Versions
+
+| Component | Current Version | Notes |
+|-----------|----------------|-------|
+| Workflow Package (PHP) | 1.0.75 (v1), 2.0.0 (v2) | Core workflow engine |
+| Standalone Server | 0.1.0 - 0.1.9, 2.0.0 | Language-neutral HTTP server |
+| CLI | 0.1.0 | Command-line interface |
+| Python SDK | 0.1.0 | Python client and worker |
+| Waterline | 1.0.16 (v1), 2.0.0 (v2) | Observability UI |
+
+## Compatibility Matrix
+
+### Server ↔ SDK/CLI
+
+| Server Version | CLI 0.1.x | Python SDK 0.1.x | PHP Workflow 2.0.x |
+|----------------|-----------|------------------|-------------------|
+| 0.1.x (prerelease) | ✅ Compatible | ✅ Compatible | ✅ Compatible |
+| 2.0.x (stable) | ✅ Compatible | ✅ Compatible | ✅ Compatible |
+| 1.x | ❌ Skipped | ❌ Skipped | ❌ Skipped |
+| 3.x+ (future) | ❌ Breaking | ❌ Breaking | ❌ Breaking |
+
+**Version 1.x**: Intentionally skipped. The project moved from 0.x (prerelease) directly to 2.x (stable).
+
+**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.
+
+### Workflow Package ↔ Waterline
+
+| Workflow Version | Waterline 1.x | Waterline 2.x |
+|------------------|---------------|---------------|
+| 1.x | ✅ Compatible | ❌ Not compatible |
+| 2.x | ❌ Not compatible | ✅ Compatible |
+
+Waterline versions must match the workflow package major version.
+
+## Runtime Validation
+
+### CLI
+
+The CLI validates server version on first invocation per session:
+
+```bash
+$ dw server:health
+Server version 3.0.0 is incompatible with dw CLI 0.1.x (requires server 0.x or 2.x).
+Upgrade the server or use a compatible CLI version.
+```
+
+Version checks are cached per CLI invocation. Starting a new CLI command re-validates.
+
+### Python SDK
+
+The Python SDK validates server version when workers register:
+
+```python
+from durable_workflow import Client, Worker
+
+client = Client("http://server:8080", token="...", namespace="default")
+worker = Worker(client, task_queue="default", workflows=[...])
+
+await worker.run()  # Validates server version before registering
+```
+
+If incompatible:
+
+```
+RuntimeError: Server version 3.0.0 is incompatible with sdk-python 0.1.x
+(requires server 0.x or 2.x). Upgrade the server or use a compatible SDK version.
+```
+
+### Server
+
+The server returns its version and supported SDK versions in `GET /api/cluster/info`:
+
+```json
+{
+  "version": "2.0.0",
+  "supported_sdk_versions": {
+    "php": ">=1.0",
+    "python": ">=0.1"
+  }
+}
+```
+
+Clients and workers query this endpoint to validate compatibility.
+
+## Upgrading
+
+### Minor Version Upgrades (0.1.8 → 0.1.9, 2.0.0 → 2.0.1)
+
+Minor versions are backward-compatible within the same major version:
+
+- **Server**: Upgrade without client changes
+- **CLI**: Upgrade independently
+- **Python SDK**: Upgrade independently
+
+Example: Server 2.0.1 works with CLI 0.1.0 and Python SDK 0.1.0.
+
+### Major Version Upgrades (0.x → 2.x, 2.x → 3.x)
+
+Major version changes may introduce breaking changes:
+
+1. **Check compatibility matrix** (above) for supported version combinations
+2. **Upgrade server first**: Deploy new server version
+3. **Validate with one client**: Test one CLI command or SDK worker
+4. **Upgrade remaining clients**: CLI, SDK, workers
+
+**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.
+
+**Future major versions (2.x → 3.x)**: Will require client updates. Version validation will catch incompatibilities and provide clear error messages.
+
+## Version Negotiation Protocol
+
+All client-server communication includes protocol version headers:
+
+**Control plane** (workflow start, describe, signal, query, update):
+```
+X-Durable-Workflow-Control-Plane-Version: 2
+```
+
+**Worker protocol** (task polling, completion):
+```
+X-Durable-Workflow-Protocol-Version: 1.0
+```
+
+The server validates these headers and rejects requests with missing or incompatible versions.
+
+## Troubleshooting
+
+### "Server version X is incompatible with..."
+
+**Cause**: Client and server major versions don't match.
+
+**Fix**:
+1. Check the compatibility matrix above
+2. Upgrade server or client to compatible versions
+3. If server is 0.x or 2.x and client reports incompatibility, file a bug
+
+### "Missing X-Durable-Workflow-Protocol-Version header"
+
+**Cause**: Old client not sending protocol version headers.
+
+**Fix**: Upgrade CLI to 0.1.0+ or Python SDK to 0.1.0+.
+
+### "Control plane version mismatch"
+
+**Cause**: Server and client disagree on control-plane protocol version.
+
+**Fix**: Ensure server is 0.1.x or 2.x and client is sending version 2 header.
+
+## Version History
+
+| Date | Server | CLI | Python SDK | Workflow | Waterline | Notes |
+|------|--------|-----|------------|----------|-----------|-------|
+| 2026-04-15 | 2.0.0 | 0.1.0 | 0.1.0 | 2.0.0 | 2.0.0 | Stable release |
+| 2026-04-12 | 0.1.9 | 0.1.0 | 0.1.0 | 2.0.0-alpha.2 | 2.0.0-alpha | Pre-release |
+| 2026-04-01 | 0.1.8 | 0.1.0 | 0.1.0 | 2.0.0-alpha.1 | 2.0.0-alpha | Pre-release |
+| 2026-03-15 | 0.1.7 | 0.1.0 | - | 1.0.75 | 1.0.16 | Python SDK not yet released |
+
+## See Also
+
+- [Server Setup](/docs/2.0/server-setup) — Deploying the standalone server
+- [Python SDK](/docs/2.0/sdks/python) — Python client and worker
+- [CLI](/docs/2.0/cli) — Command-line interface
+- [Migration Guide](/docs/2.0/migration) — Migrating from v1 to v2
+

404.html

@@ -13,13 +13,13 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ab866251.css">
-<link rel="preload" href="/assets/js/runtime~main.da9ba4bb.js" as="script">
-<link rel="preload" href="/assets/js/main.9abe740b.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.cf3d287d.js" as="script">
+<link rel="preload" href="/assets/js/main.d80d8b9c.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
 <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Durable Workflow</b></a><a class="navbar__item navbar__link" href="/docs/installation/">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction/">1.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/2.0/introduction/">2.0</a></li><li><a class="dropdown__link" href="/docs/introduction/">1.x</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__item navbar__link" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__link navbar-github-star-link--mobile-topbar" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation/">Installation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/xu5aDDpqVy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://x.com/DurableWorkflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://durable-workflow.com/llms-full.txt" target="_blank" rel="noopener noreferrer" class="footer__link-item">LLM Docs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://packagist.org/packages/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">Packagist<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://durable-workflow.com">Durable Workflow</a>.</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.da9ba4bb.js"></script>
-<script src="/assets/js/main.9abe740b.js"></script>
+<script src="/assets/js/runtime~main.cf3d287d.js"></script>
+<script src="/assets/js/main.d80d8b9c.js"></script>
 </body>
 </html>