Workflow: wf purge --all-older-than --all-filter-status#5075
Draft
JoshVanL wants to merge 2 commits intodapr:v1.17from
Draft
Workflow: wf purge --all-older-than --all-filter-status#5075JoshVanL wants to merge 2 commits intodapr:v1.17from
wf purge --all-older-than --all-filter-status#5075JoshVanL wants to merge 2 commits intodapr:v1.17from
Conversation
Clarify that adding or changing a retention policy does not retroactively purge workflows already in a terminal state. Include CLI examples for retroactive cleanup using `dapr workflow purge --all-older-than` and `dapr workflow list --filter-status` combined with purge. Signed-off-by: joshvanl <me@joshvanl.dev>
Update docs based on new CLI flag dapr/cli#1609 Signed-off-by: joshvanl <me@joshvanl.dev>
JoshVanL
changed the title
wf purge --all-older-than --all-filter-status
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Dapr Workflow documentation to describe and demonstrate a new purge filtering capability in the Dapr CLI, and clarifies how to retroactively clean up existing workflow history when changing retention policies.
Changes:
- Documented a new
dapr workflow purgeflag--all-filter-statusin the CLI reference. - Added purge examples showing how to filter by status (for example, purging only
FAILEDinstances). - Added an “Important” note explaining retention policy non-retroactivity and pointing users to CLI purge for retroactive cleanup.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| daprdocs/content/en/reference/cli/dapr-workflow.md | Adds --all-filter-status flag documentation and an example purge command using it. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-history-retention-policy.md | Adds an “Important” alert explaining retention policy scope and how to retroactively purge via CLI. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md | Adds a purge example demonstrating --all-filter-status usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| | `--app-id`, `-a` | string | (Required) The app ID owner of the workflow instances | | ||
| | `--all` | bool | Purge all terminal workflow instances (use with caution) | | ||
| | `--all-older-than` | string | Purge instances older than duration or timestamp (e.g., "24h", "2023-01-02T15:04:05Z") | | ||
| | `--all-filter-status` | string | Filter purge to only instances with the given runtime status. Must be used with `--all-older-than`. One of RUNNING, COMPLETED, CONTINUED_AS_NEW, FAILED, CANCELED, TERMINATED, PENDING, SUSPENDED | |
| dapr workflow purge --app-id <app-id> --all-older-than <duration> --all-filter-status FAILED | ||
| dapr workflow purge --app-id <app-id> --all-older-than <duration> --all-filter-status TERMINATED | ||
| ``` | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update docs based on new CLI flag dapr/cli#1609