How ethereum/eip-review-bot works
Project type and purpose
• This is a GitHub Action (Node.js/TypeScript) named “eip-review-bot” whose sole purpose is to listen for pull-request events on the ethereum/EIPs repository and automatically assign or request appropriate reviewers based on a set of pluggable “rule” modules.
File structure
Top-level items:
• action.yml – Action metadata & inputs/outputs
• src/ – Core TypeScript code
– action.ts – Entry point called by the GitHub runner
– process.ts – Coordinator that applies all rules
– namePr.ts, merge.ts, localConfig.ts – Helper modules
– rules/ – One file per review rule + unit tests
• __tests__ & rules/__tests__ – Jest tests for each major component
• package.json, tsconfig.json – Build & compile configuration
• docs/exitcodes.md – Documentation of exit codes
• .github/workflows/*.yml – CI and build pipelines
README for additional insights
• The README is succinct: “Automatically request reviewers for the ethereum/EIPs repository.”
a. Main components
1. GitHub (Event Source)
2. GitHub Actions Runner (Hosted environment)
3. eip-review-bot Action Code
• EntryPoint (action.ts)
• Configuration Loader (localConfig.ts)
• Processor (process.ts)
• Rule Modules (rules/*.ts)
• Helpers (namePr.ts, merge.ts)
4. GitHub REST API (Octokit)
5. Testing/CI (Jest, GitHub Workflows)
b. Relationships & data flows
– Runner invokes EntryPoint → loads config → calls Processor
– Processor loops through Rule Modules; each emits reviewer decisions
– Aggregated decisions → Octokit client → POST /pulls/:number/requested_reviewers
– CI pipelines trigger on push/PR to validate code & tests
c. Architectural patterns & principles
– Modular “Pipeline”: each rule is an independent plugin
– Single Responsibility: each .ts file has one purpose (config, naming, merge logic, rule)
– Dependency injection of Octokit for easy mocking in tests
– Clear separation of “business logic” (rules) from “Action plumbing” (action.ts)
d. Key technologies & frameworks
– TypeScript, Node.js, Bun/npm
– Octokit (GitHub REST client)
– Jest (unit tests & mocks)
– GitHub Actions (action.yml, runner environment)
– GitHub Workflows for CI & code scanning