You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: COVEN-GITHUB.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@
9
9
10
10
A GitHub App that turns any Coven-configured familiar into a first-class GitHub coding agent. Assign an issue to `@cody` (or any familiar bot user), and the familiar plans, edits, commits, and opens a pull request — with live oversight in CovenCave and no black-box model lock-in.
11
11
12
+
For the GitHub-rendered system diagrams that explain this repo at a glance, see [docs/architecture.md](docs/architecture.md).
13
+
12
14
---
13
15
14
16
## Problem
@@ -43,7 +45,29 @@ Mixing these creates a monolith that is hard to test, deploy, and reason about.
43
45
44
46
### Session Lifecycle
45
47
48
+
```mermaid
49
+
sequenceDiagram
50
+
participant GitHub
51
+
participant Webhook as coven-github webhook
52
+
participant Worker as coven-github worker
53
+
participant Runtime as coven-code headless
54
+
participant Cave as CovenCave
55
+
56
+
GitHub->>Webhook: Signed webhook for issue, label, mention, or review
57
+
Webhook->>Webhook: Validate HMAC and route familiar
58
+
Webhook->>GitHub: Create Check Run
59
+
Webhook->>Worker: Enqueue task
60
+
Worker->>Runtime: Start session with session-brief.json
61
+
Worker->>Cave: Publish live status link
62
+
Runtime-->>Worker: Structured progress and result.json
Copy file name to clipboardExpand all lines: DESIGN.md
+15-10Lines changed: 15 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
`coven-github` is a thin GitHub ingress layer for trusted familiar work. It should not become a generic agent platform inside the GitHub App. The GitHub App accepts repository events, routes them to the right familiar, records task state, and keeps humans in control through Cave oversight.
4
4
5
+
For a visual system map, webhook sequence, task lifecycle, and trust-boundary diagrams, see [Architecture Diagrams](docs/architecture.md).
6
+
5
7
## Design Goal
6
8
7
9
Assign GitHub work to a known familiar and get a draft PR back with visible context, evidence, and an oversight path.
@@ -15,16 +17,19 @@ The core design constraint is trust continuity:
15
17
16
18
## Task Flow
17
19
18
-
```text
19
-
GitHub event
20
-
-> webhook HMAC validation
21
-
-> event parsing and familiar routing
22
-
-> task record and queue
23
-
-> worker starts isolated session
24
-
-> coven-code --headless receives session brief
25
-
-> familiar drafts changes and result envelope
26
-
-> GitHub Check Run and PR are updated
27
-
-> Cave Board and session link expose oversight
20
+
```mermaid
21
+
flowchart LR
22
+
event[GitHub event]
23
+
hmac[Webhook HMAC validation]
24
+
route[Event parsing and familiar routing]
25
+
task[Task record and queue]
26
+
worker[Worker starts isolated session]
27
+
brief[coven-code receives session brief]
28
+
result[Familiar drafts changes and result envelope]
29
+
github[GitHub Check Run and PR updated]
30
+
cave[Cave Board and session link expose oversight]
Copy file name to clipboardExpand all lines: HOSTED.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,23 @@ Hosted OpenCoven is the managed version of `coven-github`: install the GitHub Ap
4
4
5
5
The hosted tier should monetize managed reliability and familiar continuity, while the open-source adapter remains self-hostable for trust and inspection.
6
6
7
+
See [Architecture Diagrams](docs/architecture.md) for the hosted vs self-hosted deployment diagram and trust-boundary map.
Copy file name to clipboardExpand all lines: README.md
+54-27Lines changed: 54 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,25 @@
4
4
5
5
`coven-github` is the GitHub App adapter for [OpenCoven](https://opencoven.ai). It bridges GitHub's issue and pull-request workflow with the Coven harness — turning any Coven-configured familiar into a first-class GitHub coding agent, without black-box model lock-in.
6
6
7
-
```
8
-
GitHub issue assigned to @cody
9
-
→ coven-github webhook receiver
10
-
→ spawns coven-code session with issue context
11
-
→ Check Run shows live progress in GitHub UI
12
-
→ familiar opens branch, commits, pushes
13
-
→ PR opened and linked to original issue
14
-
→ Cave session available for live oversight
7
+
```mermaid
8
+
flowchart LR
9
+
issue[GitHub issue, label, mention, or review comment]
10
+
app[coven-github GitHub App]
11
+
worker[coven-github worker]
12
+
familiar[coven-code familiar session]
13
+
check[GitHub Check Run]
14
+
pr[Draft pull request]
15
+
cave[CovenCave oversight]
16
+
17
+
issue --> app
18
+
app --> worker
19
+
worker --> familiar
20
+
worker --> check
21
+
familiar --> pr
22
+
worker --> cave
23
+
check --> reviewer[Maintainer]
24
+
pr --> reviewer
25
+
cave --> reviewer
15
26
```
16
27
17
28
---
@@ -24,31 +35,47 @@ Every existing GitHub coding agent is a black box: GitHub's model, GitHub's cont
24
35
25
36
That is the product wedge: assign it like a teammate, get a PR back, and keep Cave oversight in the loop. A familiar should know the difference between "technically works" and "good enough for this repo, this team, and this moment."
26
37
27
-
See [Design](DESIGN.md), [Hosted OpenCoven](HOSTED.md), [Familiar Contract](FAMILIAR-CONTRACT.md), [Roadmap](ROADMAP.md), and [Hosted vs self-hosted](docs/hosted-vs-self-hosted.md) for the operational plan.
38
+
See [Architecture Diagrams](docs/architecture.md), [Design](DESIGN.md), [Hosted OpenCoven](HOSTED.md), [Familiar Contract](FAMILIAR-CONTRACT.md), [Roadmap](ROADMAP.md), and [Hosted vs self-hosted](docs/hosted-vs-self-hosted.md) for the operational plan.
0 commit comments