Skip to content

Commit 5ef8459

Browse files
Minor documentation update (#236)
1 parent 95845c9 commit 5ef8459

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/06-cli/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,13 +357,16 @@ cadence --do samples-domain wf batch terminate -jid <batch-job-id>
357357
```
358358
Note that the operation performed by a batch will not be rolled back by terminating the batch. However, you can use reset to rollback your :workflow:workflows:.
359359

360-
#### Restart, reset workflow
360+
#### Reset workflow
361361
The Reset command allows resetting a :workflow: to a particular point and continue running from there.
362362
There are a lot of use cases:
363+
363364
- Rerun a failed :workflow: from the beginning with the same start parameters.
364365
- Rerun a failed :workflow: from the failing point without losing the achieved progress(history).
365366
- After deploying new code, reset an open :workflow: to let the :workflow: run to different flows.
366367

368+
What this command allows you to do conceptually is to go back to an earlier point in the workflow's history and re-run from that point. It allows you to pick the beginning of the workflow's history, the most recent events (the end) or in (most) segements of the workflow's history.
369+
367370
You can reset to some predefined :event: types:
368371
```bash
369372
cadence workflow reset -w <wid> -r <rid> --reset_type <reset_type> --reason "some_reason"

0 commit comments

Comments
 (0)