Skip to content

EDU-3824: Add best practice advice to Typescript Versioning - #3303

Closed
fairlydurable wants to merge 21 commits into
mainfrom
EDU-3824
Closed

fairlydurable wants to merge 21 commits into
mainfrom
EDU-3824

Conversation

@fairlydurable

@fairlydurable fairlydurable commented Jan 22, 2025 •

Copy link
Copy Markdown
Contributor

Source of truth/Author: Grant Smith

Moving to PR 3577 to make the CLA Assistant happy

@GSmithApps

Copy link
Copy Markdown
Contributor

After experimenting more in my local, I see that I'm missing something. I'll circle back when i'm more solid

@GSmithApps

GSmithApps commented Jan 26, 2025 •

Copy link
Copy Markdown
Contributor

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 👍

@GSmithApps

Copy link
Copy Markdown
Contributor

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

Comment thread docs/develop/dotnet/versioning.mdx Outdated

#### Overview

The following sample shows how the `patched()` function behaves, providing explanations at each stage of the patching flow:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a line about defining the version conditions in descending order?

@kevinawoo kevinawoo Jan 30, 2025 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

@GSmithApps Status check on this one? Thanks!

@GSmithApps

GSmithApps commented Mar 5, 2025 •

Copy link
Copy Markdown
Contributor

Applying changes to python/versioning.mdx
Updating typescript/versioning.mdx with versioning changes.

@brianmacdonald-temporal brianmacdonald-temporal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a tricky concept, and a difficult one to explain. This is a great draft that addresses the concept well. I kept the structure, but made some changes made to wording to make it read more smoothly. Please review and let me know if you have any questions.

@CLAassistant

CLAassistant commented May 12, 2025 •

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ GSmithApps
✅ brianmacdonald-temporal
❌ Erica Sadun


Erica Sadun seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@GSmithApps

Copy link
Copy Markdown
Contributor

Moving to PR 3577 to make the CLA Assistant happy

@GSmithApps GSmithApps closed this May 13, 2025
@GSmithApps
GSmithApps deleted the EDU-3824 branch July 25, 2025 16:42

This branch was successfully deployed

1 active deployment
Preview — 1d5d9127 Deployed May 12, 2025 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross-team This issue or PR was submitted from within Temporal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants