docs(workflow-executor): fix README inaccuracies#1644
Open
Scra3 wants to merge 1 commit into
Open
Conversation
- 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>
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
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.
What
Fixes three inaccuracies in
packages/workflow-executor/README.md, found while writing the developer-guide setup page:POLLING_INTERVAL_MSdefault — documented as5000, actually30000(defaults.ts:DEFAULT_POLLING_INTERVAL_MS = 30_000). Fixed in both the env table and the log example.Agent probe passedline (logged inrunner.start()) andmalformed=0on thePoll cycle completedline (third context key inrunner.ts). The poll timestamp was also wrong: the first poll fires after the interval (setTimeout(..., pollingIntervalMs)), not ~5s in.1" afterSTOP_TIMEOUT_MS. In reality (runner.tsPromise.race+build-workflow-executor.ts), a drain timeout logs aDrain timeouterror, abandons the in-flight steps, and still exits0. Exit1only 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.
POLLING_INTERVAL_MSdefault from 5000 to 30000 and updates example timestamps accordinglySTOP_TIMEOUT_MSare not awaited or force-killed, a "Drain timeout" is logged, and interrupted steps are safe to replay via a write-ahead idempotency logMacroscope summarized 25d3dc5.