|
| 1 | +# Release checklist — coven-github |
| 2 | + |
| 3 | +The first usable release (`v0.1.0`) ships only after every gate below passes. |
| 4 | +Gates 1–5 are runnable from a clean checkout with no GitHub credentials. Gate 6 |
| 5 | +needs a disposable repo with the App installed and a live `coven-code` binary — |
| 6 | +it is the human-in-the-loop step that authorizes the tag. |
| 7 | + |
| 8 | +## Gates |
| 9 | + |
| 10 | +```bash |
| 11 | +# 1. Format |
| 12 | +cargo fmt --all -- --check |
| 13 | + |
| 14 | +# 2. Type/borrow check |
| 15 | +cargo check --workspace |
| 16 | + |
| 17 | +# 3. Lint (warnings are errors) |
| 18 | +cargo clippy --workspace --all-targets -- -D warnings |
| 19 | + |
| 20 | +# 4. Tests |
| 21 | +cargo test --workspace |
| 22 | + |
| 23 | +# 5. Docs smoke — config validation + webhook signature path |
| 24 | +# (boot the server against a throwaway config, then:) |
| 25 | +cargo build --release -p coven-github |
| 26 | +./target/release/coven-github doctor --config config/local.toml |
| 27 | +scripts/smoke-webhook.sh http://localhost:3000/webhook "$WEBHOOK_SECRET" |
| 28 | +``` |
| 29 | + |
| 30 | +Gate 5 detail: `doctor` must exit `0` on a filled-in config, and |
| 31 | +`scripts/smoke-webhook.sh` must report unsigned → 401, bad signature → 401, |
| 32 | +valid signature → 200. See [docs/self-hosting.md](docs/self-hosting.md). |
| 33 | + |
| 34 | +## 6. Disposable-repo end-to-end (human-gated) |
| 35 | + |
| 36 | +On a throwaway repo with the GitHub App installed and `worker.coven_code_bin` |
| 37 | +pointing at a real `coven-code`: |
| 38 | + |
| 39 | +1. Open an issue and assign it to the configured bot user (or apply a |
| 40 | + `trigger_labels` label such as `coven:fix`). |
| 41 | +2. Confirm a Check Run appears and the familiar session starts. |
| 42 | +3. Confirm a draft PR opens in the familiar's voice and links back to the issue. |
| 43 | +4. Confirm the Check Run resolves to success/failure (not stuck). |
| 44 | + |
| 45 | +Capture the issue/PR links in the release notes as evidence. |
| 46 | + |
| 47 | +## Cut the tag |
| 48 | + |
| 49 | +Only after gates 1–6 pass: |
| 50 | + |
| 51 | +```bash |
| 52 | +# Ensure the version in Cargo.toml ([workspace.package].version) is correct, |
| 53 | +# the tree is clean, and you are on main. |
| 54 | +git tag -s v0.1.0 -m "coven-github v0.1.0" |
| 55 | +git push origin v0.1.0 |
| 56 | +``` |
| 57 | + |
| 58 | +> Tags are signed (`-s`). Do not push an unsigned release tag. |
| 59 | +
|
| 60 | +## Status of automatable gates (this branch) |
| 61 | + |
| 62 | +| Gate | Result | |
| 63 | +|---|---| |
| 64 | +| 1. `cargo fmt --all -- --check` | ✅ clean | |
| 65 | +| 2. `cargo check --workspace` | ✅ clean | |
| 66 | +| 3. `cargo clippy … -D warnings` | ✅ clean | |
| 67 | +| 4. `cargo test --workspace` | ✅ 18 passing | |
| 68 | +| 5. docs smoke (`doctor` + `smoke-webhook.sh`) | ✅ verified locally | |
| 69 | +| 6. disposable-repo E2E | ⏳ requires live App creds + `coven-code` | |
0 commit comments