Repository navigation
Conversation
🦋 Changeset detectedLatest commit: 0d00190 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The API-reference refusal list omits fatal execution-context validation failures.
Review effort: Balanced
Findings: 1
What changed in this PR
Documents corrected dynamic workflow start failure and queueing behavior.
Changes:
- Explains fatal dynamic
start()refusals. - Documents publish-after-store behavior.
- Adds a docs-only changeset.
| File | Description |
|---|---|
docs/content/docs/v5/api-reference/workflow-api/start.mdx |
Updates API failure semantics. |
docs/content/docs/v5/advanced/dynamic-workflows.mdx |
Expands dynamic workflow lifecycle guidance. |
.changeset/docs-dynamic-start-failures.md |
Records the documentation update. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| The return type is `Run<unknown>`: the source's shape is only known to whatever generated it, so there is nothing to infer. The workflow ID is derived from the source and its step bindings — it cannot be supplied. | ||
|
|
||
| A dynamic start throws a `WorkflowRuntimeError`, before anything is written, when the deployment has not opted in, when `deploymentId` targets another deployment (including `'latest'` resolving to one), or when the World's backend does not support dynamic-source storage. | ||
| A dynamic start throws a `WorkflowRuntimeError`, before anything is written, when the source is invalid, when the deployment has not opted in, when `deploymentId` targets another deployment (including `'latest'` resolving to one), or when the World's backend does not support dynamic-source storage. These errors are fatal, so a step that calls `start()` fails without retrying. |
Contributor
Sim WorldSimulated world deterministic testing for races. Traces 🟠 world-sim scenario book — 1 fail of 42 total
Full trace: |
Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
pranaygp
force-pushed
the
workflow-docs-cleanup-thu-1-oct
branch
from
October 1, 2026 16:15
ef28ba6 to
0d00190
Compare
VaguelySerious
marked this pull request as draft
October 1, 2026 19:40
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs follow-up for two dynamic workflow fixes that landed without docs changes:
start()refusals (invalid source, opt-in, same-deployment, World capability, execution-context limit) are now fatal, so a step that callsstart()fails without retrying. An unknown current deployment stays retryable.start()queues the run only afterrun_createdconfirms the code was stored, so any creation failure throws with nothing queued.Docs Preview
startreferenceThe two new paragraphs sit at the end of World support; on the
startpage, the error paragraph near the end of Dynamic Workflow Source gained the fatal note plus one new paragraph.🤖 Generated with Claude Code