Skip to content

Workflows: NonRetryableErrors Section Improvement #17819

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

Merged
merged 13 commits into from
Nov 14, 2024
Merged

Workflows: NonRetryableErrors Section Improvement #17819

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9a868de
Reenforce that for NonRetryableErrors, users need to manage the error…
bruxodasilva Oct 28, 2024
d5b6371
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
sidharthachatterjee Oct 28, 2024
028a9be
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
sidharthachatterjee Oct 28, 2024
bdc1cba
added code example to catch NonRetryableError
bruxodasilva Oct 28, 2024
c235401
imnor improvement
bruxodasilva Oct 28, 2024
52790bd
better example of how to manage catch of steps and example
bruxodasilva Oct 29, 2024
16670e9
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
25365a9
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
1fca47b
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
21f878c
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
744bbd7
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
11582c3
Update src/content/docs/workflows/build/sleeping-and-retrying.mdx
bruxodasilva Nov 8, 2024
6bed40f
minor example cleanup
bruxodasilva Nov 8, 2024
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
4 changes: 3 additions & 1 deletion src/content/docs/workflows/build/sleeping-and-retrying.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ let someState = step.do("call an API", {
}, async () => { /* Step code goes here /* }
```

## Force a Workflow to fail
## Force a Workflow Instance to fail

You can also force a Workflow instance to fail and _not_ retry by throwing a `NonRetryableError` from within the step.

Expand All @@ -111,3 +111,5 @@ export class MyWorkflow extends WorkflowEntrypoint<Env, Params> {
```

The Workflow instance itself will fail immediately, no further steps will be invoked, and the Workflow will not be retried.

Users can catch this error if they intend to continue the Workflow execution. Otherwise, the Workflow will fail.
Loading