# open-bot/open-bot architecture

> Architecture diagram of the GitHub repository open-bot/open-bot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/open-bot/open-bot
- Repository: https://github.com/open-bot/open-bot

## Overview

open-bot is a repository-configured GitHub issue and pull-request automation bot. Webhooks enqueue affected items, while the CLI can process repositories or individual items manually; the processor loads repository rules, evaluates filters, and applies configured actions. Scheduled actions and batch scheduling use a separate scheduled-task path. The graph preserves the documented webhook, CLI, rule, filtering, action, and scheduling capabilities. Some connections for unsampled handlers and rule implementations are documented but not source-verified, so they are dashed.

Main entry points: [`lib/open-bot/open-bot.js`](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/open-bot.js) (OpenBot engine), [`lib/open-bot/github.js`](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/github.js) (GitHub client), [`lib/open-bot/Config.js`](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/Config.js) (Rule configuration), [`lib/open-bot-handle-github-event/handler.js`](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-handle-github-event/handler.js) (Event handler)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry points"]
  node_cli["CLI commands<br/>[open-bot.js]"]
  node_event_handler["Event handler<br/>[handler.js]"]
  node_task_handler["Task handler<br/>[handler.js]"]
  node_scheduled_handler["Scheduled handler<br/>[handler.js]"]
  node_queue_store[("Task queue")]
end

subgraph group_engine["Rule processing"]
  node_bot_engine["OpenBot engine<br/>[open-bot.js]"]
  node_repo_config["Rule configuration<br/>[Config.js]"]
  node_filters["Issue and PR filters"]
  node_actions["Configured actions<br/>[comment.js]"]
  node_action_schedule["Schedule action<br/>[schedule.js]"]
  node_date_helpers["Date and match helpers<br/>[matchRange.js]"]
  node_templates["Message templates<br/>[interpolate.js]"]
end

subgraph group_integrations["GitHub integrations"]
  node_github_client["GitHub client<br/>[github.js]"]
  node_api_utils["API utilities<br/>[api-utils.js]"]
  node_travis_client["Travis client<br/>[travis.js]"]
end

subgraph group_scheduling["Scheduling"]
  node_scheduler["Schedule store writer<br/>[index.js]"]
  node_schedule_store[("Schedule table")]
end

node_webhook(("GitHub webhook"))
node_github_api["GitHub API"]
node_travis_service["Travis CI"]

node_webhook -.->|"delivers event"| node_event_handler
node_event_handler -->|"resolves commit PR"| node_github_client
node_event_handler -->|"enqueues item"| node_queue_store
node_queue_store -.->|"triggers processing"| node_task_handler
node_task_handler -->|"processes issues"| node_bot_engine
node_cli -->|"runs processing"| node_bot_engine
node_cli -->|"schedules items"| node_scheduler
node_bot_engine -->|"fetches repository data"| node_github_client
node_bot_engine -->|"loads rules"| node_repo_config
node_repo_config -->|"registers filters"| node_filters
node_repo_config -->|"registers actions"| node_actions
node_repo_config -.->|"registers schedule action"| node_action_schedule
node_filters -->|"uses matching helpers"| node_date_helpers
node_actions -->|"renders messages"| node_templates
node_actions -.->|"performs mutations"| node_github_client
node_action_schedule -->|"requests schedule"| node_scheduler
node_scheduler -->|"writes schedule"| node_schedule_store
node_github_client -->|"reads and mutates"| node_github_api
node_github_client -->|"fetches paginated data"| node_api_utils
node_bot_engine -->|"loads build data"| node_travis_client
node_travis_client -.->|"requests build logs"| node_travis_service
node_scheduled_handler -.->|"processes scheduled tasks"| node_bot_engine

click node_cli "https://github.com/open-bot/open-bot/blob/master/lib/open-bot-cli/open-bot.js"
click node_event_handler "https://github.com/open-bot/open-bot/blob/master/lib/open-bot-handle-github-event/handler.js"
click node_task_handler "https://github.com/open-bot/open-bot/blob/master/lib/open-bot-process-tasks/handler.js"
click node_scheduled_handler "https://github.com/open-bot/open-bot/blob/master/lib/open-bot-process-scheduled-tasks/handler.js"
click node_bot_engine "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/open-bot.js"
click node_repo_config "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/Config.js"
click node_filters "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/filters/IssuePullRequestBaseFilter.js"
click node_actions "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/actions/comment.js"
click node_action_schedule "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/actions/schedule.js"
click node_github_client "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/github.js"
click node_api_utils "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/api-utils.js"
click node_travis_client "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/travis.js"
click node_scheduler "https://github.com/open-bot/open-bot/blob/master/lib/open-bot-scheduler/index.js"
click node_date_helpers "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/helpers/matchRange.js"
click node_templates "https://github.com/open-bot/open-bot/blob/master/lib/open-bot/helpers/interpolate.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_event_handler,node_task_handler,node_scheduled_handler,node_queue_store toneBlue
class node_bot_engine,node_repo_config,node_filters,node_actions,node_action_schedule,node_date_helpers,node_templates toneAmber
class node_github_client,node_api_utils,node_travis_client,node_webhook,node_github_api toneMint
class node_scheduler,node_schedule_store toneRose
class node_travis_service toneIndigo
```

## Components

### Entry points

- [CLI commands](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-cli/open-bot.js): `lib/open-bot-cli/open-bot.js`
- [Event handler](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-handle-github-event/handler.js): `lib/open-bot-handle-github-event/handler.js`
- [Task handler](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-process-tasks/handler.js): `lib/open-bot-process-tasks/handler.js`
- [Scheduled handler](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-process-scheduled-tasks/handler.js): `lib/open-bot-process-scheduled-tasks/handler.js`
- **Task queue**

### Rule processing

- [OpenBot engine](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/open-bot.js): `lib/open-bot/open-bot.js`
- [Rule configuration](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/Config.js): `lib/open-bot/Config.js`
- [Issue and PR filters](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/filters/IssuePullRequestBaseFilter.js): `lib/open-bot/filters/IssuePullRequestBaseFilter.js`
- [Configured actions](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/actions/comment.js): `lib/open-bot/actions/comment.js`
- [Schedule action](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/actions/schedule.js): `lib/open-bot/actions/schedule.js`
- [Date and match helpers](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/helpers/matchRange.js): `lib/open-bot/helpers/matchRange.js`
- [Message templates](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/helpers/interpolate.js): `lib/open-bot/helpers/interpolate.js`

### GitHub integrations

- [GitHub client](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/github.js): `lib/open-bot/github.js`
- [API utilities](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/api-utils.js): `lib/open-bot/api-utils.js`
- [Travis client](https://github.com/open-bot/open-bot/blob/master/lib/open-bot/travis.js): `lib/open-bot/travis.js`

### Scheduling

- [Schedule store writer](https://github.com/open-bot/open-bot/blob/master/lib/open-bot-scheduler/index.js): `lib/open-bot-scheduler/index.js`
- **Schedule table**

### Other components

- **GitHub webhook**
- **GitHub API**
- **Travis CI**

## Connections

- GitHub webhook → Event handler: delivers event
- Event handler → GitHub client: resolves commit PR (evidence: `lib/open-bot-handle-github-event/handler.js`)
- Event handler → Task queue: enqueues item (evidence: `lib/open-bot-handle-github-event/handler.js`)
- Task queue → Task handler: triggers processing
- Task handler → OpenBot engine: processes issues (evidence: `lib/open-bot-process-tasks/handler.js`)
- CLI commands → OpenBot engine: runs processing (evidence: `lib/open-bot-cli/open-bot.js`)
- CLI commands → Schedule store writer: schedules items (evidence: `lib/open-bot-cli/open-bot.js`)
- OpenBot engine → GitHub client: fetches repository data (evidence: `lib/open-bot/open-bot.js`)
- OpenBot engine → Rule configuration: loads rules (evidence: `lib/open-bot/open-bot.js`)
- Rule configuration → Issue and PR filters: registers filters (evidence: `lib/open-bot/Config.js`)
- Rule configuration → Configured actions: registers actions (evidence: `lib/open-bot/Config.js`)
- Rule configuration → Schedule action: registers schedule action
- Issue and PR filters → Date and match helpers: uses matching helpers (evidence: `lib/open-bot/filters/pull_request.js`)
- Configured actions → Message templates: renders messages (evidence: `lib/open-bot/actions/comment.js`)
- Configured actions → GitHub client: performs mutations
- Schedule action → Schedule store writer: requests schedule (evidence: `lib/open-bot/actions/schedule.js`)
- Schedule store writer → Schedule table: writes schedule (evidence: `lib/open-bot-scheduler/index.js`)
- GitHub client → GitHub API: reads and mutates (evidence: `lib/open-bot/github.js`)
- GitHub client → API utilities: fetches paginated data (evidence: `lib/open-bot/github.js`)
- OpenBot engine → Travis client: loads build data (evidence: `lib/open-bot/open-bot.js`)
- Travis client → Travis CI: requests build logs
- Scheduled handler → OpenBot engine: processes scheduled tasks
