Skip to content

docs: add documentation for deploymentId: "latest" in start()#1409

Merged
TooTallNate merged 2 commits intomainfrom
docs/deploymentid-latest
Mar 16, 2026
Merged

docs: add documentation for deploymentId: "latest" in start()#1409
TooTallNate merged 2 commits intomainfrom
docs/deploymentid-latest

Conversation

@TooTallNate
Copy link
Member

@TooTallNate TooTallNate commented Mar 16, 2026

Summary

  • Add documentation for the deploymentId: "latest" option in start(), which was added in feat: support deploymentId: 'latest' in start() to resolve most recent deployment #1317 but not documented
  • Remove the @deprecated tag from StartOptions.deploymentId in @workflow/core since it doesn't render correctly in the TSDoc component and the option is actively supported
  • Add a compatibility warning callout explaining that workflow identity (function name + file path) and argument schemas must remain stable across deployments
  • Add a cross-reference callout in the "Background Execution via Step" section of Common Patterns

@vercel
Copy link
Contributor

vercel bot commented Mar 16, 2026 •
edited
Loading

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

Project Deployment Actions Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, Comment Mar 16, 2026 10:49pm
example-nextjs-workflow-webpack Ready Ready Preview, Comment Mar 16, 2026 10:49pm
example-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-astro-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-express-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-fastify-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-hono-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-nitro-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-nuxt-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-sveltekit-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workbench-vite-workflow Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workflow-docs Ready Ready Preview, Comment, Open in v0 Mar 16, 2026 10:49pm
workflow-nest Ready Ready Preview, Comment Mar 16, 2026 10:49pm
workflow-swc-playground Ready Ready Preview, Comment Mar 16, 2026 10:49pm

@TooTallNate TooTallNate requested a review from a team as a code owner March 16, 2026 22:30
Copilot AI review requested due to automatic review settings March 16, 2026 22:30
@changeset-bot
Copy link

changeset-bot bot commented Mar 16, 2026 •
edited
Loading

🦋 Changeset detected

Latest commit: 7ce28c4

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

This PR includes changesets to release 16 packages
Name Type
@workflow/core Patch
@workflow/builders Patch
@workflow/cli Patch
@workflow/next Patch
@workflow/nitro Patch
@workflow/vitest Patch
@workflow/web-shared Patch
workflow Patch
@workflow/world-testing Patch
@workflow/astro Patch
@workflow/nest Patch
@workflow/rollup Patch
@workflow/sveltekit Patch
@workflow/vite Patch
@workflow/nuxt Patch
@workflow/ai Patch

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 16, 2026 •
edited
Loading

📊 Benchmark Results

📈 Comparing against baseline from main branch. Green 🟢 = faster, Red 🔺 = slower.

workflow with no steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 0.034s (-9.8% 🟢) 1.005s (~) 0.971s 10 1.00x
💻 Local Nitro 0.040s (-9.6% 🟢) 1.005s (~) 0.966s 10 1.17x
💻 Local Next.js (Turbopack) 0.049s 1.005s 0.957s 10 1.43x
🌐 Redis Next.js (Turbopack) 0.053s 1.006s 0.952s 10 1.57x
🐘 Postgres Next.js (Turbopack) 0.060s 1.011s 0.951s 10 1.76x
🐘 Postgres Nitro 0.063s (+4.1%) 1.016s (~) 0.952s 10 1.86x
🌐 MongoDB Next.js (Turbopack) 0.112s 1.008s 0.896s 10 3.29x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 0.496s (-21.4% 🟢) 2.924s (+8.9% 🔺) 2.428s 10 1.00x
▲ Vercel Express 0.525s (+3.9%) 2.551s (+7.7% 🔺) 2.026s 10 1.06x
▲ Vercel Nitro 0.550s (+15.3% 🔺) 2.354s (-10.1% 🟢) 1.804s 10 1.11x

🔍 Observability: Next.js (Turbopack) | Express | Nitro

workflow with 1 step

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 1.091s (-0.5%) 2.006s (~) 0.914s 10 1.00x
💻 Local Next.js (Turbopack) 1.114s 2.006s 0.892s 10 1.02x
💻 Local Nitro 1.122s (-0.5%) 2.006s (~) 0.884s 10 1.03x
🌐 Redis Next.js (Turbopack) 1.127s 2.006s 0.879s 10 1.03x
🐘 Postgres Next.js (Turbopack) 1.144s 2.013s 0.869s 10 1.05x
🐘 Postgres Nitro 1.150s (+0.7%) 2.013s (~) 0.863s 10 1.05x
🌐 MongoDB Next.js (Turbopack) 1.322s 2.008s 0.687s 10 1.21x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 1.990s (-6.2% 🟢) 3.678s (-7.4% 🟢) 1.689s 10 1.00x
▲ Vercel Next.js (Turbopack) 2.076s (-4.8%) 3.946s (-1.4%) 1.870s 10 1.04x
▲ Vercel Express 2.233s (+6.1% 🔺) 3.891s (+4.9%) 1.658s 10 1.12x

🔍 Observability: Nitro | Next.js (Turbopack) | Express

workflow with 10 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 10.577s (~) 11.022s (~) 0.445s 3 1.00x
🌐 Redis Next.js (Turbopack) 10.736s 11.022s 0.286s 3 1.01x
💻 Local Next.js (Turbopack) 10.787s 11.025s 0.238s 3 1.02x
🐘 Postgres Next.js (Turbopack) 10.872s 11.039s 0.167s 3 1.03x
💻 Local Nitro 10.889s (~) 11.022s (~) 0.133s 3 1.03x
🐘 Postgres Nitro 10.969s (~) 11.043s (~) 0.074s 3 1.04x
🌐 MongoDB Next.js (Turbopack) 12.275s 13.023s 0.747s 3 1.16x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 16.701s (-1.5%) 18.248s (-0.9%) 1.547s 2 1.00x
▲ Vercel Next.js (Turbopack) 16.924s (-4.4%) 19.032s (-4.6%) 2.108s 2 1.01x
▲ Vercel Nitro 16.930s (+1.8%) 17.945s (-1.2%) 1.015s 2 1.01x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

workflow with 25 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 26.653s 27.048s 0.396s 3 1.00x
💻 Local Express 26.662s (~) 27.050s (~) 0.388s 3 1.00x
🐘 Postgres Next.js (Turbopack) 27.077s 27.733s 0.656s 3 1.02x
💻 Local Next.js (Turbopack) 27.117s 28.050s 0.933s 3 1.02x
🐘 Postgres Nitro 27.192s (~) 28.070s (~) 0.878s 3 1.02x
💻 Local Nitro 27.418s (~) 28.051s (~) 0.633s 3 1.03x
🌐 MongoDB Next.js (Turbopack) 30.431s 31.040s 0.608s 2 1.14x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Next.js (Turbopack) 43.438s (-2.1%) 45.266s (-1.9%) 1.828s 2 1.00x
▲ Vercel Nitro 44.499s (+3.1%) 47.185s (+4.3%) 2.685s 2 1.02x
▲ Vercel Express 44.983s (-1.1%) 46.871s (-1.5%) 1.887s 2 1.04x

🔍 Observability: Next.js (Turbopack) | Nitro | Express

workflow with 50 sequential steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 53.253s 54.093s 0.840s 2 1.00x
🐘 Postgres Next.js (Turbopack) 53.934s 54.104s 0.170s 2 1.01x
🐘 Postgres Nitro 54.404s (~) 55.103s (~) 0.698s 2 1.02x
💻 Local Express 54.758s (~) 55.103s (~) 0.345s 2 1.03x
💻 Local Next.js (Turbopack) 55.806s 56.098s 0.292s 2 1.05x
💻 Local Nitro 56.449s (~) 57.109s (~) 0.660s 2 1.06x
🌐 MongoDB Next.js (Turbopack) 60.461s 61.054s 0.594s 2 1.14x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 91.857s (-2.2%) 93.074s (-2.7%) 1.217s 1 1.00x
▲ Vercel Next.js (Turbopack) 94.994s (-2.7%) 97.114s (-2.6%) 2.120s 1 1.03x
▲ Vercel Nitro 98.449s (+5.2% 🔺) 99.347s (+3.8%) 0.898s 1 1.07x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Promise.all with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 1.335s 2.006s 0.671s 15 1.00x
🐘 Postgres Nitro 1.407s (-0.6%) 2.011s (~) 0.604s 15 1.05x
💻 Local Express 1.427s (-1.5%) 2.005s (~) 0.578s 15 1.07x
🐘 Postgres Next.js (Turbopack) 1.430s 2.012s 0.582s 15 1.07x
💻 Local Nitro 1.486s (-1.0%) 2.005s (~) 0.519s 15 1.11x
💻 Local Next.js (Turbopack) 1.530s 2.006s 0.476s 15 1.15x
🌐 MongoDB Next.js (Turbopack) 2.192s 3.008s 0.816s 10 1.64x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.614s (+7.4% 🔺) 3.984s (+1.0%) 1.369s 8 1.00x
▲ Vercel Express 2.921s (+22.7% 🔺) 4.272s (+10.2% 🔺) 1.351s 8 1.12x
▲ Vercel Next.js (Turbopack) 3.066s (+32.4% 🔺) 4.481s (+16.4% 🔺) 1.415s 7 1.17x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Promise.all with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 2.536s (-1.8%) 3.007s (~) 0.472s 10 1.00x
🌐 Redis Next.js (Turbopack) 2.554s 3.008s 0.454s 10 1.01x
🐘 Postgres Nitro 2.560s (-2.0%) 3.013s (~) 0.453s 10 1.01x
🐘 Postgres Next.js (Turbopack) 2.618s 3.012s 0.393s 10 1.03x
💻 Local Nitro 2.772s (+1.8%) 3.008s (~) 0.236s 10 1.09x
💻 Local Next.js (Turbopack) 2.792s 3.108s 0.316s 10 1.10x
🌐 MongoDB Next.js (Turbopack) 4.675s 5.176s 0.501s 6 1.84x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.468s (-37.1% 🟢) 3.836s (-28.8% 🟢) 1.368s 8 1.00x
▲ Vercel Nitro 2.521s (-1.7%) 4.061s (-1.8%) 1.541s 8 1.02x
▲ Vercel Next.js (Turbopack) 2.951s (+19.7% 🔺) 4.850s (+27.8% 🔺) 1.899s 7 1.20x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

Promise.all with 50 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🐘 Postgres 🥇 Nitro 4.057s (~) 4.590s (+3.2%) 0.533s 7 1.00x
🌐 Redis Next.js (Turbopack) 4.153s 4.867s 0.715s 7 1.02x
🐘 Postgres Next.js (Turbopack) 4.259s 5.018s 0.759s 6 1.05x
💻 Local Express 6.810s (-0.5%) 7.216s (-4.0%) 0.405s 5 1.68x
💻 Local Next.js (Turbopack) 7.291s 7.765s 0.474s 4 1.80x
💻 Local Nitro 7.850s (+4.0%) 8.268s (+3.1%) 0.418s 4 1.93x
🌐 MongoDB Next.js (Turbopack) 10.003s 10.347s 0.344s 3 2.47x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 3.109s (+8.9% 🔺) 4.430s (+11.5% 🔺) 1.320s 8 1.00x
▲ Vercel Express 3.179s (+7.7% 🔺) 4.898s (+10.4% 🔺) 1.720s 7 1.02x
▲ Vercel Next.js (Turbopack) 3.528s (+7.9% 🔺) 5.145s (+0.9%) 1.616s 6 1.13x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Promise.race with 10 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 1.303s 2.006s 0.703s 15 1.00x
🐘 Postgres Nitro 1.414s (-1.1%) 2.011s (~) 0.598s 15 1.08x
💻 Local Express 1.443s (-2.9%) 2.006s (~) 0.563s 15 1.11x
🐘 Postgres Next.js (Turbopack) 1.489s 2.078s 0.589s 15 1.14x
💻 Local Nitro 1.500s (~) 2.006s (~) 0.507s 15 1.15x
💻 Local Next.js (Turbopack) 1.508s 2.005s 0.497s 15 1.16x
🌐 MongoDB Next.js (Turbopack) 2.207s 3.008s 0.801s 10 1.69x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.088s (-2.2%) 3.650s (+0.8%) 1.562s 9 1.00x
▲ Vercel Next.js (Turbopack) 2.248s (+7.1% 🔺) 3.975s (+1.6%) 1.727s 8 1.08x
▲ Vercel Nitro 2.258s (+7.6% 🔺) 3.680s (+1.8%) 1.422s 9 1.08x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Promise.race with 25 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🌐 Redis 🥇 Next.js (Turbopack) 2.585s 3.008s 0.423s 10 1.00x
💻 Local Express 2.590s (-1.7%) 3.007s (~) 0.418s 10 1.00x
🐘 Postgres Nitro 2.615s (~) 3.013s (~) 0.397s 10 1.01x
🐘 Postgres Next.js (Turbopack) 2.628s 3.013s 0.385s 10 1.02x
💻 Local Next.js (Turbopack) 2.841s 3.308s 0.467s 10 1.10x
💻 Local Nitro 2.878s (-5.0% 🟢) 3.108s (-12.8% 🟢) 0.231s 10 1.11x
🌐 MongoDB Next.js (Turbopack) 4.744s 5.177s 0.433s 6 1.84x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 2.353s (-9.5% 🟢) 3.757s (-4.9%) 1.404s 9 1.00x
▲ Vercel Nitro 2.556s (-17.0% 🟢) 3.744s (-15.7% 🟢) 1.188s 9 1.09x
▲ Vercel Next.js (Turbopack) 3.499s (+12.1% 🔺) 5.253s (+11.4% 🔺) 1.753s 6 1.49x

🔍 Observability: Express | Nitro | Next.js (Turbopack)

Promise.race with 50 concurrent steps

💻 Local Development

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
🐘 Postgres 🥇 Nitro 4.044s (-0.6%) 4.588s (~) 0.545s 7 1.00x
🌐 Redis Next.js (Turbopack) 4.143s 4.867s 0.724s 7 1.02x
🐘 Postgres Next.js (Turbopack) 4.309s 5.018s 0.710s 6 1.07x
💻 Local Express 7.189s (-3.4%) 8.017s (~) 0.827s 4 1.78x
💻 Local Next.js (Turbopack) 7.890s 8.267s 0.377s 4 1.95x
💻 Local Nitro 8.491s (+8.3% 🔺) 9.021s (+5.8% 🔺) 0.530s 4 2.10x
🌐 MongoDB Next.js (Turbopack) 10.047s 10.345s 0.298s 3 2.48x
🐘 Postgres Express ⚠️ missing - - - -

▲ Production (Vercel)

World Framework Workflow Time Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Nitro 2.979s (+2.5%) 4.382s (-5.5% 🟢) 1.403s 7 1.00x
▲ Vercel Express 3.065s (+16.3% 🔺) 4.696s (+16.5% 🔺) 1.632s 7 1.03x
▲ Vercel Next.js (Turbopack) 3.469s (+14.7% 🔺) 5.256s (+3.3%) 1.787s 6 1.16x

🔍 Observability: Nitro | Express | Next.js (Turbopack)

Stream Benchmarks (includes TTFB metrics)
workflow with stream

💻 Local Development

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
💻 Local 🥇 Express 0.130s (-2.2%) 1.002s (~) 0.009s (-4.3%) 1.015s (~) 0.884s 10 1.00x
💻 Local Next.js (Turbopack) 0.162s 1.002s 0.012s 1.018s 0.855s 10 1.25x
🌐 Redis Next.js (Turbopack) 0.166s 1.001s 0.002s 1.007s 0.841s 10 1.28x
💻 Local Nitro 0.195s (-3.4%) 1.003s (~) 0.011s (+4.6%) 1.017s (~) 0.822s 10 1.49x
🐘 Postgres Next.js (Turbopack) 0.201s 1.002s 0.002s 1.013s 0.812s 10 1.54x
🐘 Postgres Nitro 0.211s (-1.4%) 0.996s (~) 0.001s (-6.7% 🟢) 1.013s (~) 0.802s 10 1.62x
🌐 MongoDB Next.js (Turbopack) 0.532s 0.917s 0.001s 1.008s 0.476s 10 4.08x
🐘 Postgres Express ⚠️ missing - - - - -

▲ Production (Vercel)

World Framework Workflow Time TTFB Slurp Wall Time Overhead Samples vs Fastest
▲ Vercel 🥇 Express 1.552s (-12.6% 🟢) 2.363s (-17.7% 🟢) 0.004s (-23.7% 🟢) 2.916s (-81.0% 🟢) 1.365s 10 1.00x
▲ Vercel Next.js (Turbopack) 1.667s (-3.9%) 2.939s (+7.1% 🔺) 0.006s (+16.7% 🔺) 3.570s (+4.6%) 1.903s 10 1.07x
▲ Vercel Nitro 1.714s (+1.7%) 2.428s (-10.4% 🟢) 0.005s (+2.0%) 2.930s (-10.2% 🟢) 1.217s 10 1.10x

🔍 Observability: Express | Next.js (Turbopack) | Nitro

Summary

Fastest Framework by World

Winner determined by most benchmark wins

World 🥇 Fastest Framework Wins
💻 Local Express 12/12
🐘 Postgres Next.js (Turbopack) 6/12
▲ Vercel Express 6/12
Fastest World by Framework

Winner determined by most benchmark wins

Framework 🥇 Fastest World Wins
Express 💻 Local 8/12
Next.js (Turbopack) 🌐 Redis 7/12
Nitro 💻 Local 4/12
Column Definitions
  • Workflow Time: Runtime reported by workflow (completedAt - createdAt) - primary metric
  • TTFB: Time to First Byte - time from workflow start until first stream byte received (stream benchmarks only)
  • Slurp: Time from first byte to complete stream consumption (stream benchmarks only)
  • Wall Time: Total testbench time (trigger workflow + poll for result)
  • Overhead: Testbench overhead (Wall Time - Workflow Time)
  • Samples: Number of benchmark iterations run
  • vs Fastest: How much slower compared to the fastest configuration for this benchmark

Worlds:

  • 💻 Local: In-memory filesystem world (local development)
  • 🐘 Postgres: PostgreSQL database world (local development)
  • ▲ Vercel: Vercel production/preview deployment
  • 🌐 Turso: Community world (local development)
  • 🌐 MongoDB: Community world (local development)
  • 🌐 Redis: Community world (local development)
  • 🌐 Jazz: Community world (local development)

📋 View full workflow run

❌ Some benchmark jobs failed:

  • Local: success
  • Postgres: failure
  • Vercel: success

Check the workflow run for details.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 16, 2026 •
edited
Loading

🧪 E2E Test Results

❌ Some tests failed

Summary

Passed Failed Skipped Total
✅ ▲ Vercel Production 560 0 67 627
✅ 💻 Local Development 600 0 84 684
✅ 📦 Local Production 600 0 84 684
✅ 🐘 Local Postgres 600 0 84 684
✅ 🪟 Windows 54 0 3 57
❌ 🌍 Community Worlds 116 55 15 186
✅ 📋 Other 144 0 27 171
Total 2674 55 364 3093

❌ Failed Tests

🌍 Community Worlds (55 failed)

mongodb (3 failed):

  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously

redis (2 failed):

  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously

turso (50 failed):

  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)

Details by Category

✅ ▲ Vercel Production
App Passed Failed Skipped
✅ astro 50 0 7
✅ example 50 0 7
✅ express 50 0 7
✅ fastify 50 0 7
✅ hono 50 0 7
✅ nextjs-turbopack 55 0 2
✅ nextjs-webpack 55 0 2
✅ nitro 50 0 7
✅ nuxt 50 0 7
✅ sveltekit 50 0 7
✅ vite 50 0 7
✅ 💻 Local Development
App Passed Failed Skipped
✅ astro-stable 48 0 9
✅ express-stable 48 0 9
✅ fastify-stable 48 0 9
✅ hono-stable 48 0 9
✅ nextjs-turbopack-canary 54 0 3
✅ nextjs-turbopack-stable 54 0 3
✅ nextjs-webpack-canary 54 0 3
✅ nextjs-webpack-stable 54 0 3
✅ nitro-stable 48 0 9
✅ nuxt-stable 48 0 9
✅ sveltekit-stable 48 0 9
✅ vite-stable 48 0 9
✅ 📦 Local Production
App Passed Failed Skipped
✅ astro-stable 48 0 9
✅ express-stable 48 0 9
✅ fastify-stable 48 0 9
✅ hono-stable 48 0 9
✅ nextjs-turbopack-canary 54 0 3
✅ nextjs-turbopack-stable 54 0 3
✅ nextjs-webpack-canary 54 0 3
✅ nextjs-webpack-stable 54 0 3
✅ nitro-stable 48 0 9
✅ nuxt-stable 48 0 9
✅ sveltekit-stable 48 0 9
✅ vite-stable 48 0 9
✅ 🐘 Local Postgres
App Passed Failed Skipped
✅ astro-stable 48 0 9
✅ express-stable 48 0 9
✅ fastify-stable 48 0 9
✅ hono-stable 48 0 9
✅ nextjs-turbopack-canary 54 0 3
✅ nextjs-turbopack-stable 54 0 3
✅ nextjs-webpack-canary 54 0 3
✅ nextjs-webpack-stable 54 0 3
✅ nitro-stable 48 0 9
✅ nuxt-stable 48 0 9
✅ sveltekit-stable 48 0 9
✅ vite-stable 48 0 9
✅ 🪟 Windows
App Passed Failed Skipped
✅ nextjs-turbopack 54 0 3
❌ 🌍 Community Worlds
App Passed Failed Skipped
✅ mongodb-dev 3 0 2
❌ mongodb 51 3 3
✅ redis-dev 3 0 2
❌ redis 52 2 3
✅ turso-dev 3 0 2
❌ turso 4 50 3
✅ 📋 Other
App Passed Failed Skipped
✅ e2e-local-dev-nest-stable 48 0 9
✅ e2e-local-postgres-nest-stable 48 0 9
✅ e2e-local-prod-nest-stable 48 0 9

📋 View full workflow run

Copilot AI reviewed Mar 16, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only PR that adds docs for the deploymentId: "latest" option in start() (introduced in #1317) and removes the @deprecated TSDoc tag from StartOptions.deploymentId.

Changes:

  • Add API reference section documenting deploymentId: "latest" with compatibility warnings
  • Add cross-reference callout in Common Patterns for background execution via step
  • Remove @deprecated tag from StartOptions.deploymentId in @workflow/core

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/content/docs/api-reference/workflow-api/start.mdx New section documenting deploymentId: "latest" with callouts
docs/content/docs/foundations/common-patterns.mdx Cross-reference callout for deploymentId: "latest"
packages/core/src/runtime/start.ts Remove @deprecated tag, improve JSDoc
.changeset/docs-deploymentid-latest.md Changeset for the patch

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@TooTallNate TooTallNate enabled auto-merge (squash) March 16, 2026 22:53
@TooTallNate TooTallNate merged commit 97e4384 into main Mar 16, 2026
101 of 102 checks passed
@TooTallNate TooTallNate deleted the docs/deploymentid-latest branch March 16, 2026 22:58
@workflow-devkit-release-bot workflow-devkit-release-bot bot mentioned this pull request Mar 16, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@VaguelySerious VaguelySerious VaguelySerious approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate @VaguelySerious