Skip to content

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

Merged
marcduiker merged 6 commits into
dapr:v1.17from
Pittu-Sharma:workflow-continue-as-new-docs-5021
Jun 4, 2026
Merged

docs: clarify continue-as-new behavior for child workflows #5021#5130
marcduiker merged 6 commits into
dapr:v1.17from
Pittu-Sharma:workflow-continue-as-new-docs-5021

Conversation

@Pittu-Sharma

Copy link
Copy Markdown
Contributor

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

@Pittu-Sharma
Pittu-Sharma requested review from a team as code owners April 20, 2026 17:44

@nelson-parente nelson-parente 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.

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.

@nelson-parente nelson-parente added this to the v1.18 milestone May 31, 2026

@marcduiker marcduiker 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.

LGTM

@marcduiker
marcduiker merged commit 580a644 into dapr:v1.17 Jun 4, 2026
7 checks passed
@marcduiker

Copy link
Copy Markdown
Contributor

@holopin-bot @Pittu-Sharma docs-badge Thank you! Here's a digital badge as a small token of appreciation.

@holopin-bot

holopin-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

Congratulations @Pittu-Sharma, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/cmqbfawoz0009ks0brog4liyj

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

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

4 participants