docs: add orchestration versioning best practices guide #46
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a practical guide for managing versioned orchestrations in production.
What's Included
register_typed()vsregister_versioned_typed()examplescontinue_as_newtime, not server restart, with timeline exampleWhy This Is Needed
The existing migration-guide.md covers breaking changes between Duroxide versions, but doesn't cover practical patterns for versioning your own orchestrations in production. This came from real-world experience implementing long-running orchestrations that needed version upgrades without disrupting in-flight instances.
Note
Introduces versioning guidance for long-lived orchestrations and how upgrades occur safely.
Orchestration Versioningsection toORCHESTRATION-GUIDE.mdcovering registration (register_typedvsregister_versioned_typed), upgrade timing atcontinue_as_new, and concise best practicesproduction-patterns.mdwith detailed patterns: code organization by stable NAME + version-suffixed functions, registry setup, upgrade timing timeline, DO/DON'T checklist, version info flow (provider → client → API → UI), and practical scenarios (hot-fix, state migration, version pinning)ORCHESTRATION-GUIDE.mdto include the new sections and link toproduction-patterns.mdWritten by Cursor Bugbot for commit 09ff705. This will update automatically on new commits. Configure here.