chore(child workflows): updated all sdk docs to clarify how to ensure a child started before a parent completes#4538
Open
flippedcoder wants to merge 2 commits intomainfrom
Open
chore(child workflows): updated all sdk docs to clarify how to ensure a child started before a parent completes#4538flippedcoder wants to merge 2 commits intomainfrom
flippedcoder wants to merge 2 commits intomainfrom
Conversation
… a child started before a parent completes
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
| A [Child Workflow Execution](/child-workflows) is a Workflow Execution that is scheduled from within another Workflow using a Child Workflow API. | ||
|
|
||
| When using a Child Workflow API, Child Workflow related Events ([StartChildWorkflowExecutionInitiated](/references/events#startchildworkflowexecutioninitiated), [ChildWorkflowExecutionStarted](/references/events#childworkflowexecutionstarted), [ChildWorkflowExecutionCompleted](/references/events#childworkflowexecutioncompleted), etc...) are logged in the Workflow Execution Event History. | ||
| When using a Child Workflow API, Child Workflow related Events ([StartChildWorkflowExecutionInitiated](/references/events#startchildworkflowexecutioninitiated), [ChildWorkflowExecutionStarted](/references/events#childworkflowexecutionstarted), [ChildWorkflowExecutionCompleted](/references/events#childworkflowexecutioncompleted), etc...) are logged in the Workflow Execution Event History. The Child Workflow needs to have an _Abandon_ [Parent Close Policy](/parent-close-policy) set in the Child Workflow Options. |
Contributor
There was a problem hiding this comment.
Why was this line about parent close policy added?
Contributor
Author
There was a problem hiding this comment.
I shuffled this line up from below and updated it a bit. Is the Parent Close Policy optional? I think I remember something about it defaulting to Abandon.
Contributor
There was a problem hiding this comment.
Yes it is optional, I don't think this sentence makes sense here.
yuandrew
reviewed
May 7, 2026
| To be sure that the Child Workflow Execution has started, first call the Child Workflow Execution method on the instance of Child Workflow future, which returns a different future. | ||
|
|
||
| Then get the value of an object that acts as a proxy for a result that is initially unknown, which is what waits until the Child Workflow Execution has spawned. | ||
| You should block progress on the Parent Workflow until the [ChildWorkflowExecutionStarted](/references/events#childworkflowexecutionstarted) Event is logged to the Event History to ensure the Child Workflow Execution has started. If the Parent makes the `ExecuteChildWorkflow` call and then immediately completes, the Child Workflow Execution doesn't start. In Python, you can make sure your Child Workflow started by awaiting `execute_child_workflow`. |
Contributor
There was a problem hiding this comment.
In Python, you can make sure your Child Workflow started by awaiting
execute_child_workflow.
I realized my statement in slack was misleading, execute_child_workflow also waits for completion, not just starting. But start_child_workflow is what ensures the workflow has started. I believe this applies to all Core SDKs. Java should follow Go
Contributor
Author
There was a problem hiding this comment.
Ah, ok. Thanks for helping me clear that up!
jsundai
approved these changes
May 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What does this PR do?
Some of the explanations in Go for how to ensure a Child Workflow started before a Parent completes were copy-pasted across all the SDKs. Except for Java, which is similar to Go, simply awaiting a Child Workflow method means it's started. This updates all the SDKs to clarify the differences.
Notes to reviewers
┆Attachments: EDU-6321 chore(child workflows): updated all sdk docs to clarify how to ensure a child started before a parent completes