|
| 1 | +# Release Checklist |
| 2 | + |
| 3 | +Run through this checklist **every release**, no exceptions. |
| 4 | + |
| 5 | +## 1. Version Bump |
| 6 | + |
| 7 | +- [ ] `Makefile` — `VERSION` variable |
| 8 | +- [ ] `npm/package.json` — `"version"` |
| 9 | +- [ ] `server.json` — `"version"` |
| 10 | +- [ ] `CHANGELOG.md` — new section at top |
| 11 | + |
| 12 | +## 2. Build & Test Gate |
| 13 | + |
| 14 | +```bash |
| 15 | +make release-candidate # precheck + vet + migration test |
| 16 | +go test ./... -count=1 # full test suite |
| 17 | +``` |
| 18 | + |
| 19 | +## 3. MCP Tool Count |
| 20 | + |
| 21 | +If tools were added/removed, update the count in **all** of these: |
| 22 | + |
| 23 | +- [ ] `README.md` — badge, MCP tools table, description |
| 24 | +- [ ] `npm/README.md` — heading + table |
| 25 | +- [ ] `AGENTS.md` — `mcp/` line in project structure |
| 26 | +- [ ] `Dockerfile` — OCI label |
| 27 | +- [ ] `server.json` — description |
| 28 | +- [ ] `glama.json` — description + tools array |
| 29 | +- [ ] `npm/package.json` — description |
| 30 | +- [ ] `internal/setup/mcp.go` — print message + tool list |
| 31 | + |
| 32 | +Quick check: `grep -rn "17 tools\|17 MCP" --include='*.md' --include='*.go' --include='*.json' --include='Dockerfile'` |
| 33 | + |
| 34 | +## 4. Doctor Check Count |
| 35 | + |
| 36 | +If checks were added/removed in `doctor_cmd.go`: |
| 37 | + |
| 38 | +- [ ] `AGENTS.md` — `doctor_cmd.go` comment |
| 39 | +- [ ] `README.md` — do NOT hardcode a number (use "20+ checks" or "diagnostic checks") |
| 40 | + |
| 41 | +Quick check: `grep -c 'check(' cmd/same/doctor_cmd.go` |
| 42 | + |
| 43 | +## 5. Public-Facing Docs |
| 44 | + |
| 45 | +- [ ] `SECURITY.md` — supported versions table |
| 46 | +- [ ] `PRIVACY.md` — data types table (add new stored data types) |
| 47 | +- [ ] `CHANGELOG.md` — no self-deprecating language ("aspirational", "inflated", etc.) |
| 48 | +- [ ] `README.md` — no inflated timing claims, feature list current |
| 49 | +- [ ] `docs/design_context.md` — "Last generated" date |
| 50 | + |
| 51 | +## 6. Scrub |
| 52 | + |
| 53 | +- [ ] No PII, banned terms, strategy language (see `.claude/CLAUDE.md`) |
| 54 | +- [ ] No embarrassing TODOs, HACKs, or debug prints in new code |
| 55 | +- [ ] Commit messages are clean (no banned terms — see `.claude/CLAUDE.md`) |
| 56 | +- [ ] No hardcoded test paths or personal directories |
| 57 | + |
| 58 | +Quick check: `git log --oneline HEAD~5..HEAD` — review every message. |
| 59 | + |
| 60 | +## 7. Security |
| 61 | + |
| 62 | +- [ ] New MCP handlers use `neutralizeTags()` on output |
| 63 | +- [ ] New file reads validate paths with `safeVaultPath()` |
| 64 | +- [ ] New XML wrapper tags added to `sanitizeContextTags()` tag list |
| 65 | +- [ ] New frontmatter writes strip newlines from user input |
| 66 | +- [ ] `make security-test` passes |
| 67 | + |
| 68 | +## 8. Tag & Push |
| 69 | + |
| 70 | +```bash |
| 71 | +git tag vX.Y.Z |
| 72 | +same push-allow && git push origin main |
| 73 | +same push-allow && git push origin vX.Y.Z |
| 74 | +``` |
| 75 | + |
| 76 | +## 9. GitHub Release |
| 77 | + |
| 78 | +```bash |
| 79 | +gh release create vX.Y.Z --title "vX.Y.Z — Title" --notes-file /tmp/release-notes.md |
| 80 | +``` |
| 81 | + |
| 82 | +## 10. npm Publish |
| 83 | + |
| 84 | +```bash |
| 85 | +cd npm && npm publish |
| 86 | +``` |
| 87 | + |
| 88 | +Verify: `npm view @sgx-labs/same version` should show the new version. |
| 89 | + |
| 90 | +## 11. Post-Release |
| 91 | + |
| 92 | +- [ ] Verify `npx -y @sgx-labs/same version` shows new version |
| 93 | +- [ ] Verify `curl -fsSL https://statelessagent.com/install.sh | bash` works |
| 94 | +- [ ] Announce on Discord |
| 95 | +- [ ] Check GitHub release page renders correctly |
0 commit comments