Skip to content

docs: clarify continue-as-new behavior for child workflows #5021#5130

Open
Pittu-Sharma wants to merge 4 commits into
dapr:v1.17from
Pittu-Sharma:workflow-continue-as-new-docs-5021
Open

docs: clarify continue-as-new behavior for child workflows #5021#5130
Pittu-Sharma wants to merge 4 commits into
dapr:v1.17from
Pittu-Sharma:workflow-continue-as-new-docs-5021

Conversation

@Pittu-Sharma
Copy link
Copy Markdown

Description

This PR addresses issue #5021 by explicitly clarifying the behavior of the continue-as-new API regarding unawaited child workflows. This is a critical detail for developers implementing the Monitor Pattern, as continue-as-new proceeds immediately and does not wait for child workflows started via CallChildWorkflowAsync (or equivalent SDK methods) unless they are explicitly awaited.

Key Changes:

  • Clarification Notes: Added standard {{% alert %}} boxes to the Monitor pattern section in workflow-patterns.md and the Infinite loops section in workflow-features-concepts.md.
  • Documentation Polish: Refined code comments across modified blocks to ensure "logical completeness." Generic placeholders (e.g., // Do some work) have been replaced with descriptive, professional business logic markers (e.g., // Initial business logic (e.g., inventory check)).
  • Quality Fixes: Corrected minor technical debt, including comment style mismatches (Python # in JS blocks) and typos ("cancled" to "cancelled").

Issue reference

Closes #5021

Signed-off-by: pittu sharma <pittusharma47@gmail.com>
Signed-off-by: pittu sharma <pittusharma47@gmail.com>
Signed-off-by: pittu sharma <pittusharma47@gmail.com>
@Pittu-Sharma Pittu-Sharma requested review from a team as code owners April 20, 2026 17:44
Copy link
Copy Markdown
Contributor

@nelson-parente nelson-parente left a comment

Choose a reason for hiding this comment

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

Pre-review for @marcduiker handoff: LGTM with nits.

  • The continue-as-new alert boxes are a useful clarification for the monitor pattern and infinite loop sections.
  • Comment improvements (replacing generic placeholders with business-logic descriptions) are a nice polish.
  • The maintainer-guide.md changes (azd auth login, remove stale SDK doc pull section) overlap with #5083 and #5101 from the same author — Marc, one of these three PRs has the maintainer-guide fix and all appear to land the same change. Confirm only one gets merged to avoid conflicts.
  • Nit: the Python comment fix from # Apply some compensating work to # Add logic here to undo partial changes accidentally appears under a JS code block (// Add logic here...) — the JS block fix looks correct; the Python snippet looks fine too.
    Nothing blocking — Marc, your call.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New content needed for dapr/dapr#9249

2 participants