Skip to content

Commit 8740255

Browse files
docs: remove github app state
1 parent e4698c5 commit 8740255

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/development.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ Directory structure:
1515
- Communication with the GitHub API and definitions of GitHub webhook messages.
1616

1717
## Architecture diagram
18-
The following diagram shows a simplified view on the important state entities of Bors. `bors_process` handles events generated by webhooks. It uses a shared global state through `BorsContext`, which holds a shared connection to the database and a command parser. It also has access to `GithubAppState`, which has a map of repository state. Each repository state contains an API client for that repository, its loaded config, and permissions loaded from the Team API.
18+
The following diagram shows a simplified view on the important state entities of Bors. `bors_process` handles events generated by webhooks. It uses a shared global state through `BorsContext`, which holds a shared connection to the database and a command parser. It also has access to a map of repository state. Each repository state contains an API client for that repository, its loaded config, and permissions loaded from the Team API.
1919

2020
```mermaid
2121
---
2222
title: Important entities
2323
---
2424
flowchart
25-
GithubAppState
25+
BorsContext
2626
repo_client_1["GithubRepositoryClient"]
2727
repo_client_2["GithubRepositoryClient"]
2828
2929
repo_state_1["RepositoryState"]
3030
repo_state_2["RepositoryState"]
3131
32-
GithubAppState --> repo_state_1 --> repo_client_1 --> repo1
33-
GithubAppState --> repo_state_2 --> repo_client_2 --> repo2
32+
BorsContext --> repo_state_1 --> repo_client_1 --> repo1
33+
BorsContext --> repo_state_2 --> repo_client_2 --> repo2
3434
3535
repo_state_1 --> cr1["Config (repo 1)"]
3636
repo_state_1 --> pr1["Permissions (repo 1)"]
@@ -40,7 +40,6 @@ flowchart
4040
4141
BorsContext --> db[(Database)]
4242
43-
bors_process --> GithubAppState
4443
bors_process --> BorsContext
4544
```
4645

0 commit comments

Comments
 (0)