Skip to content

docs-fix: call the flow runner by its name (FIX-2354) - #4909

Merged
jhoffner merged 1 commit into
mainfrom
docs-fix/FIX-2354-flow-runner
Nov 7, 2026
Merged

jhoffner merged 1 commit into
mainfrom
docs-fix/FIX-2354-flow-runner

Conversation

@jhoffner

@jhoffner jhoffner commented Nov 7, 2026

Copy link
Copy Markdown
Collaborator

The problem

FIX-2245 renamed the thing that decides where a flow action runs: it is now the flow runner. Three published lines still called it "a dispatcher". In these docs, dispatcher means only the dispatcher() block.

What this does

It renames those three lines and changes nothing else:

  • packages/core/README.md, the external-dispatcher row in the refusal table
  • apps/docs/docs/server/background-work.md, the same row
  • apps/docs/guides/background-jobs-bullmq.md, the line on custom topologies

The external-dispatcher refusal code keeps its value. It is a public wire value, and whether to rename it is FIX-2479's open question.

What's asked of you

Merge when green. This is a docs-fix because published pages change only at release otherwise. Implementation PR: #4908. Spec: specs/issues/FIX-2354/.


Generated by Claude Code

…r (FIX-2354)

FIX-2245 renamed what decides where a flow action runs to the flow runner. Three
published lines still called it a dispatcher. The external-dispatcher refusal
code keeps its public value.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011UNkLD7mJaky2QRikkQ8Z4
@vercel

vercel Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
flow-state-dev-docs Ready Ready Preview Nov 7, 2026 6:56pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flow-state-dev-ui Ignored Ignored Nov 7, 2026 6:56pm UTC
flow-state-dev-build-site Skipped Skipped Nov 7, 2026 6:56pm UTC

Request Review

@linear-code

linear-code Bot commented Nov 7, 2026

Copy link
Copy Markdown

FIX-2354

@jhoffner jhoffner added the docs-fix label Nov 7, 2026 — with Claude
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-07T18:56:49.178592Z da8f0ee PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

jhoffner commented Nov 7, 2026

Copy link
Copy Markdown
Collaborator Author

Second-look / architecture review: no changes needed.

  • Approach: The diff is 3 lines across 3 files, a pure rename of "dispatcher" to "flow runner" in the external-dispatcher rows and the custom-topology line. There is no leaner shape. A grep of apps/docs/docs, apps/docs/guides and packages/*/README.md finds no remaining "dispatcher" that means the flow runner. The leftover hits all refer to the dispatcher() block, which is correct.
  • Scope discipline: Keeping the external-dispatcher code value unchanged is right. It is a public wire value, and renaming it belongs to FIX-2479 as the PR says.
  • Nit, optional: In packages/core/README.md the row now reads "a host whose flow runner runs requests in another process … a flow runner passed directly". The repeated phrase reads slightly redundant. Something like "a host that hands requests to another process" would be tighter. It is not worth blocking on.
  • Architecture-refactor opportunity: None. A docs-only rename gives no natural seam for a refactor, and I'd keep it that way.

Safe to merge once CI is green.


Generated by Claude Code

@gitar-bot

gitar-bot Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
CI failed: Two unrelated CI test failures: a shell assertion `test "failure" = success` in Typecheck & Test, and one Shift Manager UI test (`test/shell.test.tsx:173`) that never reached the sidebar after retry, amid DNS/network errors. Neither is related to this docs-only terminology PR.

Overview

Two unique error templates from 2 logs, both on the docs-only commit da8f0ee (FIX-2354). Both failures appear unrelated to the change, which only touches documentation wording in two docs pages and packages/core/README.md.

Failures

Shell assertion test "failure" = success failed in Typecheck & Test (confidence: high)

  • Type: test
  • Affected jobs: 128499654967
  • Related to change: no
  • Root cause: The step test "failure" = success evaluates false, so the shell step exits with code 1 (Process completed with exit code 1). The PR does not touch this test or its inputs.
  • Suggested fix: Find out why the command receives failure where success is expected. Correct the test input if success is intended, or change the assertion to match the intended failure-case behavior.

Shift Manager test test/shell.test.tsx:173 failed after retry (confidence: medium)

  • Type: infrastructure
  • Affected jobs: 128496727356
  • Related to change: no
  • Root cause: One test failed at packages/shift-manager/test/shell.test.tsx:173 (712 passed, 5 skipped). The page still showed the Lab-unreachable state (503 · store offline) after Retry. Logs also show repeated EAI_AGAIN errors for lab.local and an ECONNRESET, suggesting a transient network or DNS problem. The logs do not confirm those errors came from this specific test.
  • Suggested fix: Rerun the job to check whether the network problem was transient. If it reproduces, make the test's Lab endpoint and retry response deterministic with a local mock or controlled hostname resolution, then confirm the retry reaches the sidebar.

Summary

  • Change-related failures: None. Both failures were marked related_to_pr: no.
  • Infrastructure/flaky failures: One suspected transient/network failure in Shift Manager shell.test.tsx (possible flaky test, medium confidence). It should be triaged separately.
  • Unrelated test failure: One shell assertion failure in Typecheck & Test, unrelated to the PR (high confidence).
  • Recommended action: Merge concerns are not caused by this PR. Rerun the Shift Manager job to test for flakiness, and separately investigate the "failure" = success assertion in the Typecheck & Test job.
Code Review ✅ Approved

🟢 Low risk · These three documentation terminology edits clarify the flow runner name without changing executable behavior or public wire values.

Renames three published doc lines that still called the flow runner "a dispatcher" in packages/core/README.md, apps/docs/docs/server/background-work.md, and apps/docs/guides/background-jobs-bullmq.md, leaving the external-dispatcher refusal code value unchanged. No issues found.

Verification

Rules No rules evaluated

Functional validation Not enabled

Set up

For more verification details, comment gitar display:verbose.

Tip

Comment Gitar fix CI or enable auto-apply: gitar auto-apply:on

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing compact verification results.

Comment with these commands to change the behavior for this request:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@jhoffner
jhoffner added this pull request to the merge queue Nov 7, 2026
Merged via the queue into main with commit c3b9063 Nov 7, 2026
35 of 38 checks passed
@jhoffner
jhoffner deleted the docs-fix/FIX-2354-flow-runner branch November 7, 2026 21:36

This branch was successfully deployed

1 active deployment
Preview – flow-state-dev-docs — da8f0ee4 Deployed Nov 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants