workflow history propagation docs#5153
Conversation
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
There was a problem hiding this comment.
Pull request overview
Adds documentation for “workflow history propagation” and links it from existing workflow docs to explain how a parent workflow can optionally share execution history with child workflows/activities.
Changes:
- Adds a new page describing workflow history propagation concepts, scopes, usage, and security considerations.
- Links the new page from the workflow overview and features/concepts pages.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-overview.md | Adds a new “History propagation” section linking to the new doc page. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-history-propagation.md | New doc page covering propagation scopes, setup, consuming history, and cross-app/security notes. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md | Adds a short “Workflow history propagation” section and links to the detailed page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
nelson-parente
left a comment
There was a problem hiding this comment.
Pre-review for @marcduiker handoff: LGTM. New conceptual page for workflow history propagation (164 lines) with accurate Go code examples using the durabletask-go SDK API (WithHistoryPropagation, PropagateLineage, PropagateOwnHistory, GetPropagatedHistory). Scope comparison table is clear. Pointers from workflow-overview.md and workflow-features-concepts.md are in place. Note: this covers the Go SDK; the .NET SDK doc is in #5174 — coordinate to make sure both land together or are independently valid. Safe to merge after CI.
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Cassie Coyle <cassie.i.coyle@gmail.com>
alicejgibbons
left a comment
There was a problem hiding this comment.
lgtm, just the one note: Should we add a note on payload size and limits here? I imagine that when workflow history prop is enabled the payloads increase a bit? Maybe call that out and that the default size is 4mb etc...
|
|
||
| ## Setting it up | ||
|
|
||
| A parent opts a single child workflow or activity into propagation via a per-call option. Other calls in the same workflow are unaffected. The default is no propagation. |
There was a problem hiding this comment.
maybe "opts in for..."?
|
|
||
| When a parent workflow in App A calls a child workflow in App B, the propagated chunks travel between sidecars. Two security knobs apply: | ||
|
|
||
| - **mTLS** — when Dapr is deployed with mTLS (the default for Helm / `dapr init -k`), inter-sidecar traffic is encrypted and authenticated. |
- Add propagateHistory flag to PatientRecord; PatientIntake conditionally forwards LINEAGE so reviewers can see ComplianceAudit refuse the prescription when upstream history is withheld. - Trim README per Alice's review (drop requirements blockquote, propagation-modes section, replay-safety callout, Dapr<1.18 fallback, and References list; link to dapr/docs#5153). - Update .http with both scenarios. Signed-off-by: Javier Aliaga <javier@diagrid.io>
…rkflow/workflow-features-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
…rkflow/workflow-history-propagation.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
…rkflow/workflow-features-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
…rkflow/workflow-history-propagation.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
|
All feedback is addressed. I did not rm the mtls bits. I expanded on it bc it is relevant here. |
workflow history propagation docs