Skip to content

[docs] Catch up docs with recently shipped SDK changes - #4668

Merged
pranaygp merged 2 commits into
mainfrom
workflow-docs-cleanup-tue-6-oct
Oct 6, 2026
Merged

[docs] Catch up docs with recently shipped SDK changes#4668
pranaygp merged 2 commits into
mainfrom
workflow-docs-cleanup-tue-6-oct

Conversation

@pranaygp

@pranaygp pranaygp commented Oct 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Catches the docs up with SDK changes that landed on Oct 5 without (complete) docs updates.

Change Source PR Docs edit
zstd is only written to runs whose deployment's Node.js can decode it #4640 The encryption page said "gzip, with zstd support in the format". It now states when zstd vs. gzip is used and links WORKFLOW_COMPRESSION_CODEC
Aborting a public writable keeps the accepted prefix and doesn't close the shared stream #4605 Added to the existing releaseLock() / close() callout in Streaming
Released stream writers retire their WebSocket and continue over HTTP #4605 Short paragraph under WORKFLOW_STREAMS_TRANSPORT on the Vercel World page, including the "hold the lock for a burst" tip from the world-vercel README

I reviewed the other Oct 5 PRs and they need no further docs: NestJS (#4604) shipped its own docs, the @vercel/queue bump (#4648) and world-local hook fix (#4636) aren't user-facing in the docs, and #4632/#4618 are docs PRs. The Workflows pages in vercel/front were also checked and need no changes for these.

Docs Preview

Page Preview
Encryption Compression
Streaming Writing to another run's stream
Vercel World WORKFLOW_STREAMS_TRANSPORT

🤖 Generated with Claude Code

Copilot AI balanced review requested due to automatic review settings October 6, 2026 16:06
@pranaygp
pranaygp requested a review from a team as a code owner October 6, 2026 16:06
@vercel

vercel Bot commented Oct 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
example-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-express-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-python-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workflow-docs Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workflow-swc-playground Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workflow-tarballs Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC
workflow-web Ready Ready Preview, v0 Oct 6, 2026 6:14pm UTC

@changeset-bot

changeset-bot Bot commented Oct 6, 2026 •
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5f307b0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

Copilot AI reviewed Oct 6, 2026

Copilot AI left a comment

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Oct 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟠 world-sim scenario book — 1 fail of 42 total

fence=per-spec

scenario outcome events virt replay violations
✅ smoke-no-steps completed 3 0ms ok 0
✅ smoke-one-step completed 6 0ms ok 0
✅ hook-at-step-started completed 12 0ms ok 0
✅ hook-at-step-completed completed 12 0ms ok 0
✅ hook-at-hook-created completed 12 0ms ok 0
✅ deadline-hook-wins completed 7 1.0h ok 0
✅ deadline-expires completed 7 1.0h ok 0
✅ step-vs-timer-early-settlement completed 8 1.0h ok 0
✅ long-sleep completed 11 30.0d ok 0
✅ hook-never-arrives stalled 3 0ms skipped 0
✅ step-retries-twice completed 10 2.0s ok 0
✅ parallel-steps completed 9 0ms ok 0
✅ hook-on-execution-state completed 12 0ms ok 0
✅ peek-hook-before-branch completed 12 0ms ok 0
✅ peek-hook-after-branch completed 12 0ms ok 0
✅ peek-hook-at-registration completed 12 0ms ok 0
✅ race-hook-before-probe completed 12 0ms ok 0
✅ race-hook-after-probe completed 12 0ms ok 0
✅ race-duplicate-delivery completed 13 0ms ok 0
✅ attr-hook-before-step completed 11 0ms ok 0
✅ attr-hook-after-step completed 11 0ms ok 0
✅ attr-from-step-body completed 13 0ms ok 0
✅ fork-hook-after-timeout completed 14 1.0m ok 0
✅ fork-hook-before-timeout completed 14 1.0m ok 0
✅ count-hook-after-timeout completed 17 1.0m ok 0
✅ count-hook-before-timeout completed 20 1.0m ok 0
✅ stale-read-step-count-fork completed 20 1.0m ok 0
✅ stale-read-equal-step-counts completed 14 1.0m ok 0
✅ step-vs-step-fork completed 12 0ms ok 0
✅ step-vs-step-fork-fenced completed 12 0ms ok 0
✅ fence-catches-benign-direction completed 12 5ms ok 0
✅ in-flight-before-decision completed 17 1.0m ok 0
❌ in-flight-before-decision-counted completed 17 1.0m ok 0
✅ in-flight-after-decision completed 19 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 20 1.0m ok 0
✅ fork-hook-wins completed 13 1.0m ok 0
✅ fork-timeout-wins completed 13 1.0m ok 0
✅ unclaimed-payload-under-fork completed 17 1.0m ok 0
✅ claimed-payload-under-fork completed 17 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 12 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

pranaygp
pranaygp commented Oct 6, 2026
View reviewed changes
Comment thread docs/content/docs/v5/api-reference/workflow/create-hook.mdx Outdated
```

`experimental_minRetention` accepts the same values as [`sleep()`](/docs/api-reference/workflow/sleep): a duration string such as `"30d"`, a number of milliseconds, or an absolute `Date`. Durations start when `createHook()` runs.
`experimental_minRetention` accepts the same values as [`sleep()`](/docs/api-reference/workflow/sleep): a duration string such as `"30d"`, a number of milliseconds, or an absolute `Date`. Durations start when `createHook()` runs. Like `sleep()`, `createHook()` throws if the value is an Invalid Date or ends past the latest time a `Date` can represent.

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

unnecessary (too verbose)

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

remove this change

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed in 5f307b0.

pranaygp
pranaygp commented Oct 6, 2026
View reviewed changes
Comment thread docs/content/docs/v5/api-reference/workflow/retryable-error.mdx Outdated
}
```

The `RetryableError` constructor throws if `retryAfter` is an Invalid Date or a duration that ends past the latest time a `Date` can represent.

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

too verbose and unnecessary

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed in 5f307b0.

pranaygp
pranaygp commented Oct 6, 2026
View reviewed changes
Comment thread docs/content/docs/v5/api-reference/workflow/sleep.mdx Outdated
}
```

`sleep()` throws if it receives an Invalid Date, such as `new Date("not a date")`, or a duration that ends past the latest time a `Date` can represent.

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

too verbose and unnecessary

@pranaygp pranaygp Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed in 5f307b0.

vercel Bot and others added 2 commits October 6, 2026 18:11
@vercel @pranaygp
[docs] Catch up docs with recently shipped SDK changes
e06f955 
Co-Authored-By: Claude <noreply@anthropic.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
@vercel @pranaygp
[docs] Drop Invalid Date notes per review
5f307b0 
Co-Authored-By: Claude <noreply@anthropic.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
@pranaygp
pranaygp force-pushed the workflow-docs-cleanup-tue-6-oct branch from 0471eac to 5f307b0 Compare October 6, 2026 18:11
@pranaygp
pranaygp enabled auto-merge (squash) October 6, 2026 18:28
@pranaygp
pranaygp disabled auto-merge October 6, 2026 18:28
@pranaygp
pranaygp merged commit e947429 into main Oct 6, 2026
66 checks passed
@pranaygp
pranaygp deleted the workflow-docs-cleanup-tue-6-oct branch October 6, 2026 18:28
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

No backport to stable for e947429 (AI decision).

This commit documents newly shipped 5.x SDK behavior (Node.js-gated zstd codec, abort() semantics on shared writables, and WebSocket writer release under WORKFLOW_STREAMS_TRANSPORT), which is documenting new capabilities rather than correcting content that is wrong on stable. I verified none of the edited text exists on stable (git grep for "zstd support in the format", "WORKFLOW_STREAMS_TRANSPORT", and the releaseLock()/close() callout all return nothing under origin/stable:docs/content), so the underlying features aren't on the maintenance line. Backporting would describe behavior 4.x users don't have.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

e947429e2b039a3e9fa53d17bd22e952ef691423

This branch was successfully deployed

1 active deployment
Preview – workflow-docs — 5f307b06 Deployed Oct 6, 2026 by vercel[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pranaygp