[codex] Link TypeScript webhook deployment - #36
Merged
Conversation
Signed-off-by: Val Alexander <bunsthedev@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the canonical coven-github documentation to point readers to the separate TypeScript webhook deployment bundle repo, and explains how it relates to this repository’s GitHub App manifest + headless execution contract for self-hosting/hosted setups.
Changes:
- Adds
OpenCoven/coven-github-webhookto the README component list and “Related” section. - Adds cross-repo guidance in
README.md,HOSTED.md, anddocs/self-hosting.mdto direct operators to the TypeScript entrypoint and its policy/connection docs. - Clarifies (at a high level) that the TypeScript bundle relies on this repo’s GitHub App manifest and headless contract.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Links the TypeScript webhook deployment bundle and adds a short self-hosting pointer + related-link entry. |
| HOSTED.md | Notes that the lightweight TypeScript webhook deployment bundle lives in a separate repository and describes its relationship to hosted flow. |
| docs/self-hosting.md | Adds an upfront pointer for operators who prefer the TypeScript deployment bundle over the Rust service entrypoint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `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 | |
Comment on lines
+150
to
+153
| 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. |
Comment on lines
+8
to
+10
| 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`. |
Comment on lines
+11
to
+12
| It uses this repo's GitHub App manifest and headless contract, then maps | ||
| installation/repository IDs to familiar routes through a local JSON policy. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
coven-githubdocs to the TypeScriptcoven-github-webhookdeployment bundle.Verification
cargo test --workspace --lockedgit diff --check