Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about retryInterval making workflow long-running #10355

Merged
merged 1 commit into from
Nov 29, 2024
Merged

docs: add note about retryInterval making workflow long-running #10355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...ps/book/app/learn/advanced-development/workflows/long-running-workflow/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ The second step has in its configuration object `async` set to `true` and it doe

So, when you execute the `hello-world` workflow, it continues its execution in the background once it reaches the second step.

<Note>

A workflow is also considered long-running if one of its steps has their `retryInterval` option set as explained in [this chapter](../retry-failed-steps/page.mdx).

</Note>

---

## Change Step Status
Expand Down
10 changes: 7 additions & 3 deletions www/apps/book/app/learn/advanced-development/workflows/retry-failed-steps/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,7 @@ The first line indicates the first time the step was executed, and the next two

## Step Retry Intervals

By default, a step is retried immediately after it fails.

To specify a wait time before a step is retried, pass a `retryInterval` property to the step's configuration object. Its value is a number of seconds to wait before retrying the step.
By default, a step is retried immediately after it fails. To specify a wait time before a step is retried, pass a `retryInterval` property to the step's configuration object. Its value is a number of seconds to wait before retrying the step.

For example:

Expand All @@ -82,3 +80,9 @@ const step1 = createStep(
}
)
```

### Interval Changes Workflow to Long-Running

By setting `retryInterval` on a step, a workflow becomes a [long-running workflow](../long-running-workflow/page.mdx) that runs asynchronously in the background. So, you won't receive its result or errors immediately when you execute the workflow.

Instead, you must subscribe to the workflow's execution using the Workflow Engine Module Service. Learn more about it in [this chapter](../long-running-workflow/page.mdx#access-long-running-workflow-status-and-result).
Loading