docs(workflow-executor): add Quick Setup section#1679
Merged
Conversation
|
Coverage Impact This PR will not change total coverage. 🚦 See full report on Qlty Cloud »🛟 Help
|
EnkiP
approved these changes
Jun 19, 2026
Two paths: in-memory (no database, testing only) and with Postgres (production), with credentials location and AGENT_URL explanation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Keep only Quick Setup — in-memory and with database. Programmatic use, example scaffold and architecture live in CLAUDE.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
FOREST_ENV_SECRET comes from the Forest Admin UI, FOREST_AUTH_SECRET is defined by the client and not available on app.forestadmin.com. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…v vars Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Require latest agent version and workflowExecutorUrl config with Node.js example. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…no Python Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Scra3
force-pushed
the
docs/workflow-executor-quick-setup
branch
from
f538b6f to
586ce66
Compare
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
2 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
packages/workflow-executor/README.md--in-memory(no database, testing only) and with Postgres (production)AGENT_URLexplanation🤖 Generated with Claude Code
Note
Add Quick Setup section to workflow-executor README
Rewrites README.md to replace the detailed 'Running in production' section with a concise 'Prerequisites' and 'Quick Setup' section covering two paths: in-memory mode and database-backed mode, both using
npx @forestadmin/workflow-executorinstead of the globally installedforest-workflow-executorCLI. Removes sections on programmatic use, development scaffolding, architecture, log format overrides, health checks, graceful shutdown, and exit codes.Macroscope summarized 586ce66.