Skip to content

Commit eb6c4f6

Browse files
authored
docs: link typescript webhook deployment
Connects the canonical coven-github docs to the TypeScript coven-github-webhook deployment bundle and its example policy.
1 parent b71050e commit eb6c4f6

3 files changed

Lines changed: 19 additions & 0 deletions

File tree

HOSTED.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ The hosted tier should monetize managed reliability and familiar continuity, whi
66

77
See [Architecture Diagrams](docs/architecture.md) for the hosted vs self-hosted deployment diagram and trust-boundary map.
88

9+
The lightweight TypeScript webhook deployment bundle now lives in
10+
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook).
11+
It uses this repo's GitHub App manifest and headless contract, then maps
12+
installation/repository IDs to familiar routes through a local JSON policy.
13+
914
## Hosted Flow
1015

1116
```mermaid

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ For deeper system, sequence, state, security-boundary, and hosted deployment dia
8484
| `crates/worker` | this repo | Task runner: spawns coven-code, streams progress, posts Check Runs |
8585
| `crates/github` | this repo | GitHub API client: installations, Check Runs, PRs, comments |
8686
| `crates/config` | this repo | Familiar config, installation registry, model routing |
87+
| `coven-github-webhook` | [OpenCoven/coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) | TypeScript deployment bundle for the hosted/self-hostable webhook entrypoint |
8788
| `coven-code` | [OpenCoven/coven-code](https://github.com/OpenCoven/coven-code) | Execution runtime (headless mode) |
8889
| `CovenCave` | [OpenCoven/coven-cave](https://github.com/OpenCoven/coven-cave) | Oversight UI |
8990

@@ -146,6 +147,11 @@ Prefer containers? A multi-stage [`Dockerfile`](Dockerfile) and
146147

147148
See [docs/self-hosting.md](docs/self-hosting.md) for GitHub App registration, permissions, smoke tests, and troubleshooting. For a minimal familiar route, start from [`examples/familiar-github-starter`](examples/familiar-github-starter/).
148149

150+
For a lightweight TypeScript deployment entrypoint that follows this app
151+
contract, use
152+
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook)
153+
with its `config/example-policy.json` and connection guide.
154+
149155
---
150156

151157
## Sponsor / Hosted Tier
@@ -159,6 +165,7 @@ See [Hosted OpenCoven](HOSTED.md) and [Hosted vs self-hosted](docs/hosted-vs-sel
159165
## Related
160166

161167
- [coven-code](https://github.com/OpenCoven/coven-code) — execution runtime
168+
- [coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) — TypeScript webhook deployment bundle
162169
- [coven-cave](https://github.com/OpenCoven/coven-cave) — oversight UI
163170
- [cast-codes](https://github.com/OpenCoven/cast-codes) — local IDE with CastAgent
164171

docs/self-hosting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
This guide walks you through registering a GitHub App and running `coven-github` on your own infrastructure.
44

5+
If you want the lightweight TypeScript deployment bundle instead of the Rust
6+
service entrypoint, use
7+
[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook)
8+
after completing the GitHub App registration steps below. Its connection guide
9+
uses this repo's manifest and maps installation/repository IDs into
10+
`config/example-policy.json`.
11+
512
## Prerequisites
613

714
- Rust toolchain (`rustup`)

0 commit comments

Comments
 (0)