[perf]: add configurable dirs option to withWorkflow#843
Merged
karthikscale3 merged 7 commits intomainfrom Jan 28, 2026
Merged
Conversation
🦋 Changeset detectedLatest commit: 1da647b The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Nitro | Next.js (Turbopack) workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Nitro | Next.js (Turbopack) Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Stream Benchmarks (includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests🌍 Community Worlds (161 failed)mongodb (40 failed):
redis (40 failed):
starter (41 failed):
turso (40 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
|
karthikscale3
requested review from
TooTallNate and
VaguelySerious
and removed request for
TooTallNate
karthikscale3
requested review from
TooTallNate and
pranaygp
and removed request for
VaguelySerious
pranaygp
reviewed
Jan 23, 2026
Allow users to specify which directories to scan for workflow directives, helping reduce memory usage and build times in large Next.js applications. - Add `dirs` option that overrides the default directories - Document all configuration options in API reference - Add troubleshooting guide for OOM errors during build
Add missing import statements and nextConfig declaration to the troubleshooting code example to fix docs typecheck.
Move the OOM troubleshooting section from the API reference to the existing troubleshooting section in docs/getting-started/next.mdx for better discoverability.
pranaygp
reviewed
Jan 26, 2026
VaguelySerious
approved these changes
Jan 28, 2026
Merged
Contributor
|
@karthikscale3 I think this makes sense, but why don't you include "src/workflows" and "workflows" by default? That seems to be even more important than all the other directories, as e.g. the docs for Next.js suggest this directory. Which feels right, just like I would put "components", "lib", "actions" etc. next to the "app" folder, not inside it. |
Merged
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
5 participants
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.
Summary
Adds a
dirsconfiguration option towithWorkflow()that allows users to specify which directories to scan for workflow directives. This addresses OOM errors in large Next.js applications where scanning the entirepages/appdirectories consumes excessive memory.Changes
dirsoption towithWorkflow()config (overrides defaults when provided)['pages', 'app', 'src/pages', 'src/app']withWorkflowconfiguration options in API referenceUsage
import { withWorkflow } from "workflow/next";
export default withWorkflow(nextConfig, {
// Only scan specific directories instead of entire app
dirs: ['workflows', 'app/api'],
});