EDU-3824: Add best practice advice to Typescript Versioning #3303
Conversation
Source of truth: Grant Smith
fairlydurable
added
waiting-on-tech-review
GSmithApps
added
the
work-in-progress
|
After experimenting more in my local, I see that I'm missing something. I'll circle back when i'm more solid |
|
Okay yeah I have a pretty good grasp of what's going on now -- at least in the python SDK. I'll need to revise the writuep and test in other SDKs, but I made a little youtube series deep diving into it. we can maybe put that in the docs too 👍 |
|
Yep, I looked into TS and Dotnet as well. Here's the writeup. I'll work on getting it to a point that can be merged etc |
docs/develop/dotnet/versioning.mdx
Outdated
| @@ -108,6 +108,90 @@ Implementing patching involves three steps: | |||
| 2. Remove the old code and apply [DeprecatePatch](https://dotnet.temporal.io/api/Temporalio.Workflows.Workflow.html#Temporalio_Workflows_Workflow_DeprecatePatch_System_String_). | |||
| 3. Once you're confident that all old Workflows have finished executing, remove `DeprecatePatch`. | |||
|
|
|||
| #### Overview | |||
|
|
|||
| The following sample shows how the `patched()` function behaves, providing explanations at each stage of the patching flow: | |||
There was a problem hiding this comment.
Can we add a line about defining the version conditions in descending order?
There was a problem hiding this comment.
Something like
The best practice is to write your version conditionals in descending order so that newly executed workflows will set their marker as the latest version.
The default value for the version is
""(empty string)
fairlydurable
added
cross-team
|
@GSmithApps Status check on this one? Thanks! |
fairlydurable
added
waiting-on-docs-review
Source of truth/Author: Grant Smith