Skip to content

docs(next): document workflow discovery and server actions - #2003

Closed
EfeDurmaz16 wants to merge 5 commits into
vercel:mainfrom
EfeDurmaz16:efe/docs-next-discovery-server-actions
Closed

docs(next): document workflow discovery and server actions#2003
EfeDurmaz16 wants to merge 5 commits into
vercel:mainfrom
EfeDurmaz16:efe/docs-next-discovery-server-actions

Conversation

@EfeDurmaz16

Copy link
Copy Markdown
Contributor

Summary

  • document how the Next.js integration discovers workflows from start() calls in app/pages entries
  • clarify that Server Actions can call start(), while workflow-imported modules should not carry top-level "use server"
  • add a small split-wrapper example for Server Actions and workflow logic

Closes #817.

Verification

  • pnpm install
  • pnpm --filter docs lint:links
  • pnpm --filter docs build (blocked by existing prerender failure on /en/v5/docs/api-reference/workflow-api/get-hook-by-token: generateDefinition.code resolved as any; build reached this unrelated docs page after compiling successfully)

Notes

The local environment warns that Node v26.0.0 is outside the repo supported engine range (^18 || ^20 || ^22 || ^24).

@EfeDurmaz16
EfeDurmaz16 requested a review from a team as a code owner May 15, 2026 10:03
@changeset-bot

changeset-bot Bot commented May 15, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 26684ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

@EfeDurmaz16 is attempting to deploy a commit to the Vercel Labs Team on Vercel.

A member of the Team first needs to authorize it.

Signed-off-by: EfeDurmaz16 <efebarandurmaz05@gmail.com>
@EfeDurmaz16
EfeDurmaz16 force-pushed the efe/docs-next-discovery-server-actions branch from 5332b5a to 7bf9024 Compare May 15, 2026 10:04
Comment thread docs/content/docs/v5/api-reference/workflow-next/with-workflow.mdx Outdated
Comment thread docs/content/docs/v5/api-reference/workflow-next/with-workflow.mdx Outdated
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
Comment thread docs/content/docs/v5/api-reference/workflow-next/with-workflow.mdx Outdated
Comment thread docs/content/docs/v5/api-reference/workflow-next/with-workflow.mdx Outdated
….mdx

Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
Comment thread docs/content/docs/v5/api-reference/workflow-next/with-workflow.mdx Outdated
VaguelySerious and others added 2 commits June 10, 2026 16:43
Co-authored-by: Peter Wielander <mittgfu@gmail.com>
Signed-off-by: Peter Wielander <mittgfu@gmail.com>
Note that workflow/step files are discovered transitively through imports and
can live anywhere (not just app/pages), and condense the discovery and
"use server" sections.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@VaguelySerious VaguelySerious left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(AI) Approving. Verified the documented behavior against the implementation:

  • Entry scanning of App Router route/page/layout and pages/src/pages matches packages/next builder config (dirs: ['pages','app','src/pages','src/app']) and the eager builder's entry filter.
  • start is exported from workflow/api, and discovery is transitive through the import graph — workflow/step files don't need to live under app/pages.
  • The "use server" incompatibility (synchronous module-init wrapper → Server Actions must be async functions) is accurate.

The two markdown rendering bugs (stray code fence; missing blank line before the Monorepos heading) were already fixed by the code-review commits. I pushed a follow-up that clarifies the transitive-discovery behavior and tightens the prose in both new sections. docs lint:links passes.

VaguelySerious pushed a commit that referenced this pull request Jun 10, 2026
Add "Workflow Discovery in Next.js" and "Server Actions and use server"
sections to the withWorkflow() reference. Ports the intended additions from
#2003 (the lazyDiscovery doc edits are omitted — main already supersedes them).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Workflow discovery mechanism and "use server" incompatibility

2 participants