Skip to content

workflow: document per-workflow state retention - #5491

Open
JoshVanL wants to merge 1 commit into
dapr:v1.20from
JoshVanL:workflow-retention-per-workflow
Open

JoshVanL wants to merge 1 commit into
dapr:v1.20from
JoshVanL:workflow-retention-per-workflow

Conversation

@JoshVanL

Copy link
Copy Markdown
Member

Dapr can now set retention durations per workflow name under spec.workflow.stateRetentionPolicy.workflows.

Add a per-workflow section to the history retention policy page with an example, the precedence order, how names are matched (exact, versions, child and multi-app workflows, ContinueAsNew, instance ID reuse) and the validation rules. List stateRetentionPolicy in the configuration overview workflow table.

Dapr can now set retention durations per workflow name under
spec.workflow.stateRetentionPolicy.workflows.

Add a per-workflow section to the history retention policy page with an
example, the precedence order, how names are matched (exact, versions,
child and multi-app workflows, ContinueAsNew, instance ID reuse) and the
validation rules. List stateRetentionPolicy in the configuration overview
workflow table.

Signed-off-by: joshvanl <me@joshvanl.dev>
@JoshVanL
JoshVanL requested review from a team as code owners November 14, 2026 16:30
Copilot AI balanced review requested due to automatic review settings November 14, 2026 16:30

Copilot AI 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.

🟢 Approval recommended

No active review issues require changes to the per-workflow state retention documentation.

No open issues 🎉

What changed in this PR

Documents per-workflow state retention in Dapr, explaining how workflow-specific durations interact with app-wide defaults.

Changes:

  • Adds a YAML example and precedence flowchart for per-workflow retention.
  • Explains name matching, workflow lifecycle cases, and configuration validation.
  • Lists stateRetentionPolicy in the configuration overview with a link to the detailed guide.
File Description
daprdocs/​content/​en/​operations/​configuration/​configuration-overview.md Adds the retention policy to the workflow configuration table.
daprdocs/​content/​en/​developing-applications/​building-blocks/​workflow/​workflow-history-retention-policy.md Documents per-workflow retention, precedence, matching, and validation.

Review effort: Balanced

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.

2 participants