diff --git a/HOSTED.md b/HOSTED.md index 342b375..ddcabf0 100644 --- a/HOSTED.md +++ b/HOSTED.md @@ -6,6 +6,11 @@ The hosted tier should monetize managed reliability and familiar continuity, whi See [Architecture Diagrams](docs/architecture.md) for the hosted vs self-hosted deployment diagram and trust-boundary map. +The lightweight TypeScript webhook deployment bundle now lives in +[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook). +It uses this repo's GitHub App manifest and headless contract, then maps +installation/repository IDs to familiar routes through a local JSON policy. + ## Hosted Flow ```mermaid diff --git a/README.md b/README.md index d112186..89e46f9 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ For deeper system, sequence, state, security-boundary, and hosted deployment dia | `crates/worker` | this repo | Task runner: spawns coven-code, streams progress, posts Check Runs | | `crates/github` | this repo | GitHub API client: installations, Check Runs, PRs, comments | | `crates/config` | this repo | Familiar config, installation registry, model routing | +| `coven-github-webhook` | [OpenCoven/coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) | TypeScript deployment bundle for the hosted/self-hostable webhook entrypoint | | `coven-code` | [OpenCoven/coven-code](https://github.com/OpenCoven/coven-code) | Execution runtime (headless mode) | | `CovenCave` | [OpenCoven/coven-cave](https://github.com/OpenCoven/coven-cave) | Oversight UI | @@ -146,6 +147,11 @@ Prefer containers? A multi-stage [`Dockerfile`](Dockerfile) and 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/). +For a lightweight TypeScript deployment entrypoint that follows this app +contract, use +[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook) +with its `config/example-policy.json` and connection guide. + --- ## Sponsor / Hosted Tier @@ -159,6 +165,7 @@ See [Hosted OpenCoven](HOSTED.md) and [Hosted vs self-hosted](docs/hosted-vs-sel ## Related - [coven-code](https://github.com/OpenCoven/coven-code) — execution runtime +- [coven-github-webhook](https://github.com/OpenCoven/coven-github-webhook) — TypeScript webhook deployment bundle - [coven-cave](https://github.com/OpenCoven/coven-cave) — oversight UI - [cast-codes](https://github.com/OpenCoven/cast-codes) — local IDE with CastAgent diff --git a/docs/self-hosting.md b/docs/self-hosting.md index 2060eb5..29fbca3 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -2,6 +2,13 @@ This guide walks you through registering a GitHub App and running `coven-github` on your own infrastructure. +If you want the lightweight TypeScript deployment bundle instead of the Rust +service entrypoint, use +[`OpenCoven/coven-github-webhook`](https://github.com/OpenCoven/coven-github-webhook) +after completing the GitHub App registration steps below. Its connection guide +uses this repo's manifest and maps installation/repository IDs into +`config/example-policy.json`. + ## Prerequisites - Rust toolchain (`rustup`)