Skip to content

Minor fixes to versioning.md #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
donald-pinckney merged 2 commits into from
Apr 17, 2026
Merged

Minor fixes to versioning.md #64

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09e71e7
Edits to python versioning fixes
donald-pinckney Apr 1, 2026
ce65ebd
add missing workflow imports
donald-pinckney Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Edits to python versioning fixes
  • Loading branch information
@donald-pinckney
donald-pinckney committed Apr 17, 2026
commit 09e71e711c0e55c308c91d7d7b908c0bdf3d6dba
21 changes: 16 additions & 5 deletions references/python/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,12 @@ worker = Worker(
Workflows stay locked to their original Worker version:

```python
from temporalio.workflow import VersioningBehavior
from temporalio.common import VersioningBehavior

@workflow.defn
@workflow.defn(versioning_behavior=VersioningBehavior.PINNED)
class StableWorkflow:
@workflow.run
async def run(self) -> str:
# This workflow will always run on its assigned version
return await workflow.execute_activity(
process_order,
start_to_close_timeout=timedelta(minutes=5),
Expand All @@ -250,6 +249,19 @@ class StableWorkflow:

Workflows can move to newer versions:

```python
from temporalio.common import VersioningBehavior

@workflow.defn(versioning_behavior=VersioningBehavior.AUTO_UPGRADE)
class UpgradableWorkflow:
@workflow.run
async def run(self) -> str:
return await workflow.execute_activity(
process_order,
start_to_close_timeout=timedelta(minutes=5),
)
```

**When to use AUTO_UPGRADE:**

- Long-running workflows (weeks or months)
Expand All @@ -262,7 +274,6 @@ Workflows can move to newer versions:
### Worker Configuration with Default Behavior

```python
# For short-running workflows, prefer PINNED
worker = Worker(
client,
task_queue="orders-task-queue",
Expand All @@ -274,7 +285,7 @@ worker = Worker(
build_id=os.environ["BUILD_ID"],
),
use_worker_versioning=True,
# default_versioning_behavior=VersioningBehavior.PINNED,
default_versioning_behavior=VersioningBehavior.PINNED,
),
)
```
Expand Down