[1.18] Breaking change on workflow id reuse policy#5102
Conversation
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
There was a problem hiding this comment.
Pull request overview
Documents a breaking behavior change in Dapr Workflows where workflow instance IDs can no longer be reused after completion/failure.
Changes:
- Adds an entry to the breaking changes/deprecations tracker noting removal of workflow instance ID reuse.
- Updates workflow concepts docs to state instance IDs are not reusable after completion/failure.
- Updates workflow architecture docs to remove mention of instance ID reuse from
metadatakey description.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md | Adds a new row documenting the removal of workflow instance ID reuse policy (with release/version info). |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md | Updates workflow identity guidance to state instance IDs cannot be reused. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-architecture.md | Updates actor state key documentation to remove reuse-specific rationale for the generation field. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Workflow instance IDs can no longer be reused by creating a new workflow with the same ID. Workflow histories are immutable records and should only be removed through the purge API or a retention policy, not overwritten via workflow creation. The instance ID reuse policy option (IGNORE, TERMINATE actions) previously available in some SDKs has also been removed. Ref: dapr/dapr#9739 Signed-off-by: joshvanl <me@joshvanl.dev>
JoshVanL
changed the title
nelson-parente
left a comment
nelson-parente
left a comment
There was a problem hiding this comment.
Pre-review for @marcduiker handoff: LGTM. This is the breaking change doc for v1.18 workflow ID reuse removal. Coverage is complete across all affected files: workflow-features-concepts.md (concept update + alert), howto-manage-workflow.md (CLI comment + alert), workflow_api.md (start endpoint + 409 response code), workflow-architecture.md (prose update), and breaking-changes-and-deprecations.md (new entry). The alert text is clear and actionable (purge API / retention policy links). Safe to merge after CI.
We are removing the reuse policy for the Workflows API in this PR