Skip to content

workflow pause: document interactions with schedules#4754

Merged
jsundai merged 6 commits into
mainfrom
spk/schedules-wf-pause
Jul 1, 2026
Merged

workflow pause: document interactions with schedules#4754
jsundai merged 6 commits into
mainfrom
spk/schedules-wf-pause

Conversation

@spkane31

@spkane31 spkane31 commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Clearly documents the behavior of Schedules when a created workflow is paused, specifically around the overlap policy. It also adds clarification that a paused schedule does not pause the created workflow.

┆Attachments: EDU-6577 workflow pause: document interactions with schedules

@spkane31
spkane31 requested a review from a team as a code owner June 22, 2026 22:46
@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Jun 30, 2026 8:33pm

Request Review

@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links


Schedule behavior is governed by the Schedule's [Overlap Policy](/schedule#overlap-policy).
If a Workflow Execution started by a Schedule is [Paused](/cli/command-reference/workflow#pause), it remains open and counts as the running execution for overlap decisions.
See [Overlap Policy](/schedule#overlap-policy) for details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The third sentence "See Overlap Policy for details." could be removed since it's already linked in the 1st sentence.

Comment thread docs/develop/go/workflows/schedules.mdx Outdated

Schedule behavior is governed by the Schedule's [Overlap Policy](/schedule#overlap-policy).
If a Workflow Execution started by a Schedule is [Paused](/cli/command-reference/workflow#pause), it remains open and counts as the running execution for overlap decisions.
See [Overlap Policy](/schedule#overlap-policy) for details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This third sentence "See Overlap Policy for details." could be removed since it's already linked in the 1st sentence - same for the rest of the schedule pages for each SDK.

5. **Eliminate External Dependencies:**
Schedules remove the need to integrate external scheduling systems.

If a Workflow Execution started by a Schedule is [Paused](/cli/command-reference/workflow#pause), it remains open and can affect future scheduled starts through the Schedule's [Overlap Policy](/schedule#overlap-policy).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link can be removed since it's linked below.

Comment thread docs/encyclopedia/workflow/schedule.mdx Outdated
- `AllowAll` Starts any number of concurrent Workflow Executions.
With this policy (and only this policy), more than one Workflow Execution, started by the Schedule, can run simultaneously.

##### Interaction with Workflow Pause {/* #workflow-pause */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd recommend bumping it up to level #### - it doesn't show up on the right TOC with ##### so this was a bit hard to find in the site preview.

If a Workflow Execution started by a Schedule is [Paused](/cli/command-reference/workflow#pause), it remains open and can affect future scheduled starts through the Schedule's [Overlap Policy](/schedule#overlap-policy).
For policy-specific behavior, see [Overlap Policy](/schedule#overlap-policy).

Jump straight to a Temporal SDK feature guide.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!!

@jsundai
jsundai merged commit c2ef554 into main Jul 1, 2026
9 checks passed
@jsundai
jsundai deleted the spk/schedules-wf-pause branch July 1, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants