|
| 1 | +# Release runbook — v0.1.0 (manual, operator-executed) |
| 2 | + |
| 3 | +Distribution model is set by [ADR 0015](adr/0015-defer-crates-io-distribution.md): |
| 4 | +**no crates.io for v0.1.0** — ship via `cargo install --git` + prebuilt GitHub |
| 5 | +Release binaries. Every step here is **reversible** (re-privatise the repo, edit |
| 6 | +or delete a Release, move a tag) — the opposite of a crates.io publish. |
| 7 | + |
| 8 | +Going public and creating a Release are **hard-confirm gates** (CLAUDE.md |
| 9 | +"Decision points"). Run these yourself in your own terminal. |
| 10 | + |
| 11 | +This runbook is append-friendly: future versions add a new section. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Precondition — already satisfied (do NOT redo) |
| 16 | + |
| 17 | +Verified this cycle on `a3ff6d4` (= `v0.1.0^{commit}` = the annotated, pushed tag): |
| 18 | + |
| 19 | +- `v0.1.0` annotated tag exists on origin → `a3ff6d4` (object `c0b583d8`). |
| 20 | +- CI green: `fmt` · `clippy -D warnings` · `build --locked` · **test 368 passed / 2 skipped** · `doc -D warnings`. |
| 21 | +- `cargo deny check` ok · `cargo audit` 0 vuln (3 allowed warns, ADR 0011). |
| 22 | +- `cargo package -p mcp-loadtest` packages + verifies (115 files). |
| 23 | +- Cargo.toml registry metadata complete (used by the deferred crates.io path; harmless now). |
| 24 | +- crates.io names `mcp-loadtest` / `mcp-loadtest-cli` free as of 2026-05-18 (only relevant if the Appendix is ever taken). |
| 25 | + |
| 26 | +Optional quick re-confirm (safe, read-only): |
| 27 | + |
| 28 | +```bash |
| 29 | +git fetch origin --tags |
| 30 | +test "$(git rev-parse 'v0.1.0^{commit}')" = "$(git rev-parse HEAD || true)" && echo "HEAD == tag" || echo "HEAD != tag (build the release from the tag)" |
| 31 | +cargo package -p mcp-loadtest --locked # must succeed |
| 32 | +``` |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## Gate A — make the repo public _(hard-confirm; reversible)_ |
| 37 | + |
| 38 | +Both distribution channels need a public repo. `Cargo.toml` |
| 39 | +`repository`/`homepage` already point at the canonical URL. |
| 40 | + |
| 41 | +- [ ] Repo is **public** at `https://github.com/Teerapat-Vatpitak/mcp-loadtest`. |
| 42 | +- [ ] `v0.1.0` tag is on origin: `git ls-remote --tags origin v0.1.0` → prints `…refs/tags/v0.1.0`. |
| 43 | +- [ ] Push the post-tag docs commits so the public `main` matches reality: |
| 44 | + `git push origin main` (carries the v0.2 backlog + the ADR 0015 doc set; |
| 45 | + the `v0.1.0` tag does **not** include them — intentional). |
| 46 | +- [ ] Smoke the first channel immediately: |
| 47 | + `cargo install --git https://github.com/Teerapat-Vatpitak/mcp-loadtest mcp-loadtest-cli` |
| 48 | + then `mcp-loadtest --version && mcp-loadtest doctor`. |
| 49 | + |
| 50 | +Reversibility: the repo can be set private again; nothing is permanent here. |
| 51 | + |
| 52 | +## Gate B — prebuilt binaries via cargo-dist _(hard-confirm; reversible)_ |
| 53 | + |
| 54 | +```bash |
| 55 | +cargo install cargo-dist # or: cargo binstall cargo-dist |
| 56 | +dist init # interactive: pick Linux/macOS/Windows targets, |
| 57 | + # writes [workspace.metadata.dist] + .github/workflows/release.yml |
| 58 | +git add Cargo.toml dist-workspace.toml .github/workflows/release.yml |
| 59 | +git commit -m "build(dist): add cargo-dist release workflow" |
| 60 | +git push origin main |
| 61 | +``` |
| 62 | + |
| 63 | +Then produce the binaries for the existing `v0.1.0` tag. The generated workflow |
| 64 | +triggers on a tag push; since `v0.1.0` is already pushed, pick one: |
| 65 | + |
| 66 | +- **Build + attach locally** (no tag churn): `dist build` then attach the |
| 67 | + artifacts when you create the Release in Gate C (`gh release create … <files>`). |
| 68 | +- **Or** re-run the release workflow via `workflow_dispatch` for the `v0.1.0` |
| 69 | + tag from the Actions tab. |
| 70 | + |
| 71 | +Do **not** delete-and-repush the `v0.1.0` tag to re-trigger CI — moving a pushed |
| 72 | +tag is destructive and needs explicit sign-off. |
| 73 | + |
| 74 | +- [ ] Binaries built for Linux + macOS + Windows. |
| 75 | + |
| 76 | +## Gate C — GitHub Release _(hard-confirm; tag already pushed; reversible)_ |
| 77 | + |
| 78 | +```bash |
| 79 | +sed -n '/## \[0\.1\.0\]/,/^\[Unreleased\]:/p' CHANGELOG.md | sed '$d' > /tmp/relnotes-0.1.0.md |
| 80 | +gh release create v0.1.0 --verify-tag --title "v0.1.0" \ |
| 81 | + --notes-file /tmp/relnotes-0.1.0.md \ |
| 82 | + ./target/distrib/* # the cargo-dist artifacts (path per `dist build` output) |
| 83 | +``` |
| 84 | + |
| 85 | +(Short body alternative: `--notes "First public release. Install: cargo install --git … . See CHANGELOG.md §[0.1.0]."`) |
| 86 | + |
| 87 | +- [ ] Release shows the binaries + source archives. |
| 88 | +- [ ] A Release can be edited or deleted later — nothing append-only here. |
| 89 | + |
| 90 | +## Gate D — announce _(manual)_ |
| 91 | + |
| 92 | +- [ ] HN / lobste.rs / r/rust per DESIGN.md §10. Lead with the deadlock demo; |
| 93 | + install line is the `cargo install --git` one (not `cargo install`). |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +## Caveats & rollback |
| 98 | + |
| 99 | +- **Everything here is reversible** — the whole reason for ADR 0015. Repo → |
| 100 | + private again; Release → edit/delete; binaries → re-upload; tag → (with |
| 101 | + sign-off) move. Contrast crates.io: a version there is permanent. |
| 102 | +- **Post-tag commits** (v0.2 backlog `4729fb1`, the ADR 0015 doc set) are _not_ |
| 103 | + in `v0.1.0`. Intentional — planning/distribution docs must not mutate a |
| 104 | + shipped tag. The tag is the code; `main` is where the docs move forward. |
| 105 | +- If a Bash/permission rule blocks a step inside Claude, run it in your own |
| 106 | + terminal; nothing about this release requires it to run inside Claude. |
| 107 | + |
| 108 | +## Appendix — crates.io (deferred, ADR 0015) |
| 109 | + |
| 110 | +Recorded for the future revisit (trigger: 0.x API stabilises, or a real external |
| 111 | +library consumer asks). Append-only — only do this when the name/API commitment |
| 112 | +is acceptable. |
| 113 | + |
| 114 | +```bash |
| 115 | +# scoped token (publish-new + publish-update) at https://crates.io/settings/tokens |
| 116 | +cargo login |
| 117 | +git switch --detach v0.1.0 # publish from the exact tagged commit |
| 118 | +cargo publish -p mcp-loadtest --locked |
| 119 | +# wait ~1–2 min for the index |
| 120 | +cargo publish -p mcp-loadtest-cli --locked |
| 121 | +git switch main |
| 122 | +``` |
| 123 | + |
| 124 | +When this is taken, update README/DESIGN install lines back to plain |
| 125 | +`cargo install mcp-loadtest-cli` and write the follow-up ADR that closes ADR |
| 126 | +0015's revisit question. |
0 commit comments