[codex] Add Workflow Pause documentation#4729
Conversation
|
Deployment failed with the following error: Learn More: https://vercel.com/docs/concepts/projects/project-configuration |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📖 Docs PR preview links |
| :::note Pre-release | ||
|
|
||
| Workflow Pause is in [Pre-release](/evaluate/development-production-features/release-stages#pre-release). In Temporal | ||
| Cloud, Pre-release access is invite-only; contact your Temporal account team or |
There was a problem hiding this comment.
Are we still planning on enabling this by default?
| | [Pause](#pause) | Stops a Workflow Execution from making new progress. | [`temporal workflow pause`](/cli/command-reference/workflow#pause) | | ||
| | [Unpause](#unpause) | Resumes a Paused Workflow Execution. | [`temporal workflow unpause`](/cli/command-reference/workflow#unpause) | | ||
|
|
||
| ## Pause {/* #pause */} |
There was a problem hiding this comment.
Can remove the comment here and for pause
| ### Scope | ||
|
|
||
| - Workflow Pause applies to a single Workflow Execution. | ||
| - It doesn't pause [Child Workflows](/child-workflows), Schedules, Task Queues, or Namespaces. |
There was a problem hiding this comment.
| - It doesn't pause [Child Workflows](/child-workflows), Schedules, Task Queues, or Namespaces. | |
| - It doesn't pause [Child Workflows](/child-workflows), Activities, Schedules, Task Queues, or Namespaces. |
|
I think we should add some information about billing for workflow pause / unpause. Specifically it would be good to say that when a workflow is paused it still incurs the cost of active storage. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -107,7 +107,7 @@ cases differently, for example releasing held resources on Pause while preservin | |||
|
|
|||
| ### Interaction with Workflow Pause | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Interaction with Workflow Pause' should use sentence-style capitalization.
| @@ -0,0 +1,197 @@ | |||
| --- | |||
| id: workflow-pause | |||
There was a problem hiding this comment.
[Temporal.terms] Use 'Workflow' instead of 'workflow' when referring to a Temporal term.
| title: Workflow Pause | ||
| sidebar_label: Workflow Pause | ||
| description: Pause and Unpause a Workflow Execution to stop new progress without terminating the Workflow or losing state. | ||
| slug: /workflow-pause |
There was a problem hiding this comment.
[Temporal.terms] Use 'Workflow' instead of 'workflow' when referring to a Temporal term.
|
|
||
| Pause stops a Workflow Execution from making new progress until it is Unpaused. | ||
|
|
||
| ### When to Pause |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'When to Pause' should use sentence-style capitalization.
|
|
||
| Unpause resumes a Paused Workflow Execution. | ||
|
|
||
| ### When to Unpause |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'When to Unpause' should use sentence-style capitalization.
| ### What happens when you Unpause a Workflow | ||
|
|
||
| - **Workflow Tasks and Activity Tasks can be dispatched again.** | ||
| - **Signals received and timers that fired while Paused are processed by the Workflow.** |
There was a problem hiding this comment.
[Temporal.terms] Use 'Timers' instead of 'timers' when referring to a Temporal term.
| - Workflow Pause is an operational control. It isn't intended to be called from Workflow code. | ||
| - There is no indicator that all in-flight Activity attempts have completed after a Workflow is Paused. | ||
|
|
||
| ## Interaction with Activity Operations |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Interaction with Activity Operations' should use sentence-style capitalization.
3 participants
What changed
Why
Workflow Pause needs public Pre-release documentation that explains when to use Pause and Unpause, what behavior users should expect, observability, limitations, and the relationship to Activity Operations.
Notes
Validation
git diff --checkandgit diff --cached --check.node_modules,yarn, orcorepackavailable.┆Attachments: EDU-6549 [codex] Add Workflow Pause documentation