Skip to content

docs(workflow-executor): fix README inaccuracies#1644

Open
Scra3 wants to merge 1 commit into
mainfrom
docs/fix-workflow-executor-readme
Open

docs(workflow-executor): fix README inaccuracies#1644
Scra3 wants to merge 1 commit into
mainfrom
docs/fix-workflow-executor-readme

Conversation

@Scra3

@Scra3 Scra3 commented Jun 10, 2026

Copy link
Copy Markdown
Member

What

Fixes three inaccuracies in packages/workflow-executor/README.md, found while writing the developer-guide setup page:

  1. POLLING_INTERVAL_MS default — documented as 5000, actually 30000 (defaults.ts: DEFAULT_POLLING_INTERVAL_MS = 30_000). Fixed in both the env table and the log example.
  2. Startup log example — was missing the Agent probe passed line (logged in runner.start()) and malformed=0 on the Poll cycle completed line (third context key in runner.ts). The poll timestamp was also wrong: the first poll fires after the interval (setTimeout(..., pollingIntervalMs)), not ~5s in.
  3. Graceful shutdown / exit codes — the README claimed steps are "force-killed and the process exits with code 1" after STOP_TIMEOUT_MS. In reality (runner.ts Promise.race + build-workflow-executor.ts), a drain timeout logs a Drain timeout error, abandons the in-flight steps, and still exits 0. Exit 1 only happens on startup error or a resource-cleanup failure during shutdown.

Why

The developer-guide page initially inherited these errors from the README. Fixing the source so the next person doesn't recopy them.

🤖 Generated with Claude Code

Note

Fix inaccuracies in workflow-executor README

Updates README.md to correct several inaccuracies introduced by prior changes.

  • Changes documented POLLING_INTERVAL_MS default from 5000 to 30000 and updates example timestamps accordingly
  • Adds an "Agent probe passed" log line to the startup example and a "malformed" counter to poll cycle log examples
  • Revises the graceful shutdown description: polling stops first, steps still running after STOP_TIMEOUT_MS are not awaited or force-killed, a "Drain timeout" is logged, and interrupted steps are safe to replay via a write-ahead idempotency log
  • Corrects exit codes: code 0 now covers graceful shutdown even when drain timed out; code 1 now covers startup errors or resource cleanup failures

Macroscope summarized 25d3dc5.

- POLLING_INTERVAL_MS default is 30000, not 5000 (defaults.ts)
- Startup log example: add 'Agent probe passed' line, malformed=0 on
  poll cycle, and correct poll timestamp (first poll fires after the
  interval, not ~5s)
- Shutdown: a drain timeout abandons in-flight steps and still exits 0;
  steps are not force-killed and STOP_TIMEOUT_MS does not cause exit 1.
  Exit 1 is startup error or resource cleanup failure.

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.

1 participant