fix: clarify workflow run queue setting (#6180)

This commit is contained in:
Cindy Li 2026-05-26 16:17:28 -04:00 committed by GitHub
parent 83eb2cabe8
commit ead3c97fbd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 17 additions and 11 deletions

View file

@ -12616,7 +12616,7 @@
"run_sequentially": {
"type": "boolean",
"nullable": true,
"title": "Run Sequentially"
"title": "Prevent Overlapping Runs"
},
"sequential_key": {
"type": "string",
@ -12760,7 +12760,7 @@
},
"run_sequentially": {
"type": "boolean",
"title": "Run Sequentially",
"title": "Prevent Overlapping Runs",
"default": false
},
"sequential_key": {

View file

@ -131,9 +131,9 @@ Also verify:
</Accordion>
<Accordion title="How do I run workflows sequentially with the same credentials?">
Use the "Run Sequentially" option with a credential key:
Use the "Prevent Overlapping Runs" option with a credential key:
1. Enable "Run Sequentially" in workflow settings
1. Enable "Prevent Overlapping Runs" in workflow settings
2. Set the sequential key to your credential identifier
3. Skyvern will queue runs that share the same credential

View file

@ -209,7 +209,7 @@ See [Using Artifacts](/developers/debugging/using-artifacts) for the full list o
**Fix:**
- Wait for other runs to complete
- Check your plan's concurrency limits in Settings
- If using "Run Sequentially" with credentials, ensure prior runs finish
- If using "Prevent Overlapping Runs" with credentials, ensure prior runs finish
</Accordion>
<Accordion title="504 Gateway Timeout on browser session">

View file

@ -20020,7 +20020,7 @@
"type": "null"
}
],
"title": "Run Sequentially"
"title": "Prevent Overlapping Runs"
},
"sequential_key": {
"anyOf": [
@ -20283,7 +20283,7 @@
},
"run_sequentially": {
"type": "boolean",
"title": "Run Sequentially",
"title": "Prevent Overlapping Runs",
"default": false
},
"sequential_key": {

View file

@ -51,6 +51,12 @@ import {
type WorkflowStartNodeData,
} from "./types";
const PREVENT_OVERLAPPING_RUNS_TOOLTIP =
"Queues new runs of this workflow until any in-progress run finishes. Does not affect block ordering inside a single run; blocks always execute in declared order. Use this when concurrent runs would collide on shared state, such as the same credentials, browser session, or downstream account.";
const SEQUENTIAL_KEY_TOOLTIP =
"Scope the run queue. Runs with the same key are queued together; runs with different keys can still execute in parallel. Templated against workflow parameters, for example {{ account_id }} to serialize per account.";
function WorkflowSettingsEditor({ blockId }: { blockId: string }) {
// Subscribe to the start node's data slice. The sidebar mount lives
// outside the per-node renderer, and the body also subscribes to
@ -255,8 +261,8 @@ function WorkflowSettingsEditorBody({
<div className="flex flex-col gap-4">
<div className="space-y-2">
<div className="flex items-center gap-2">
<Label>Run Sequentially</Label>
<HelpTooltip content="Run the workflow in a sequential order" />
<Label>Prevent Overlapping Runs</Label>
<HelpTooltip content={PREVENT_OVERLAPPING_RUNS_TOOLTIP} />
<Switch
className="ml-auto"
checked={data.runSequentially}
@ -274,7 +280,7 @@ function WorkflowSettingsEditorBody({
<div className="space-y-2">
<div className="flex gap-2">
<Label>Sequential Key (optional)</Label>
<HelpTooltip content="A static or dynamic key for directing sequential workflow execution." />
<HelpTooltip content={SEQUENTIAL_KEY_TOOLTIP} />
</div>
<WorkflowBlockInputTextarea
nodeId={blockId}

View file

@ -1207,7 +1207,7 @@ class WorkflowCreateYAMLRequest(BaseModel):
adaptive_caching: bool = False
code_version: int | None = Field(default=None, ge=1, le=2)
generate_script_on_terminal: bool = False
run_sequentially: bool = False
run_sequentially: bool = Field(default=False, title="Prevent Overlapping Runs")
sequential_key: str | None = None
folder_id: str | None = None