Docs/migration 1x to 2x - #655
Conversation
31f5f5e to
162361b
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
162361b to
e4ae074
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
e4ae074 to
2681198
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
6f1d145 to
185e012
Compare
This comment has been minimized.
This comment has been minimized.
185e012 to
be09914
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
be09914 to
6c1c23f
Compare
Codex AI reviewNo actionable findings. Changes are documentation-only; residual risk is limited to future API/documentation drift. Reviewed commit |
Claude AI reviewDocumentation-only PR: a new I verified the guide's technical claims against the source rather than reviewing runtime behavior, since inaccurate migration docs would misdirect users:
No inaccurate statements or broken examples found. No actionable findings. Residual test risk: the guide's code snippets and Reviewed commit |
| empty string checkpoint payload is currently treated as no stored polling state | ||
| on resume, so the operation may restart from `initial_state`. | ||
|
|
||
| ## New in 2.x: Custom Completion Predicate (Optional) |
There was a problem hiding this comment.
New features belong elsewhere, don't they?
| | For `map`/`parallel`, a custom `summary_generator` output is now stored under a `"summary"` key in an SDK-owned envelope (it no longer replaces the checkpoint payload). `ChildConfig.summary_generator` is unchanged: its output is still checkpointed verbatim | If you parse `map`/`parallel` summary payloads from execution history, read the `"summary"` key from the envelope. Child-context summary consumers need no change. | | ||
| | `WaitDecision` removed; `WaitStrategyConfig.timeout` / `timeout_seconds` removed | Use `WaitForConditionDecision` (`stop_polling()` / `continue_waiting(delay)`). | | ||
| | `wait_for_condition` raises `WaitForConditionError` when it exhausts `max_attempts` | Catch `WaitForConditionError` instead of inspecting the returned state. | | ||
|
|
There was a problem hiding this comment.
empy str payloads? 1.x dropped them when serializing; 2.x preserves them (b448f3e). A workflow that observed None in 1.x can observe "" in 2.x.
|
|
||
| ## What Changed and What to Do | ||
|
|
||
| | Change | What you must do | |
There was a problem hiding this comment.
To help w seo and instead of table (formatting on table for longer text can be limiting)... taking example from https://github.com/aws/aws-sdk-js-v3/blob/main/UPGRADING.md or https://docs.python.org/3/whatsnew/3.12.html#porting-to-python-3-12, how about a
## Porting to 2.0
### CallableruntimeErrror removed
<<before>>.
<<after>>
Catch `StepError`, `InvokeError`, `ChildContextError`, or `WaitForConditionError` (or the base `DurableOperationError`) instead of `CallableRuntimeError`.
### Remove x
<<before>>
<<after>>
this also makes it more feasible to have meaningful little code snippets in triple backticks etc.
Issue #, if available: N/A
Description of changes:
Migration guide for python v2
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.