Skip to content

Commit 05388a3

Browse files
committed
docs: link the primary-instance deploy gap runbook from DEVELOPING/RELEASING/AGENTS
1 parent 1cab7c1 commit 05388a3

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,13 @@ Run the browser suites only when your change touches them or when you are explic
132132

133133
For normal issue work, run the smallest relevant verification first. Do not default to repo-wide typecheck/build/test on every heartbeat when a narrower check is enough to prove the change.
134134

135+
For any change you intend to verify against a live, already-running server rather than a freshly
136+
started one, first confirm which commit that server is actually running (`GET /api/health` ->
137+
`commit`) — a long-lived primary/production instance can be many commits behind `master`. See
138+
`doc/PRIMARY-DEPLOY-GAP.md` for the deploy path, the operator-restart requirement, and the required
139+
disclosure ("verified against local dev on commit X" vs. "verified against the primary instance")
140+
when reporting a server-side fix as verified.
141+
135142
Run this full check before claiming repo work done in a PR-ready hand-off, or when the change scope is broad enough that targeted checks are not sufficient:
136143

137144
```sh

doc/DEVELOPING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -749,6 +749,14 @@ Expected:
749749
- `/api/health` returns `{"status":"ok"}`
750750
- `/api/companies` returns a JSON array
751751
752+
`/api/health` also returns `version`/`serverVersion` and `commit` (the running build's git SHA) once
753+
the caller has full-details access (board/agent actor, or any caller in `local_trusted` dev). Compare
754+
that `commit` against the commit you are trying to verify before treating a running server's behavior
755+
as proof your change is live — a long-lived primary/production instance is not guaranteed to be
756+
running the commit you just merged. See `doc/PRIMARY-DEPLOY-GAP.md` for the full deploy path, the
757+
operator-restart requirement, and the standing rule for saying explicitly which server ("local dev"
758+
vs. "primary instance") a fix was verified against.
759+
752760
## Reset Local Dev Database
753761
754762
To wipe local dev data and start fresh:

doc/RELEASING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,3 +254,6 @@ Then fix forward with a new stable release.
254254
- [`scripts/rollback-latest.sh`](../scripts/rollback-latest.sh)
255255
- [`doc/PUBLISHING.md`](PUBLISHING.md)
256256
- [`doc/RELEASE-AUTOMATION-SETUP.md`](RELEASE-AUTOMATION-SETUP.md)
257+
- [`doc/PRIMARY-DEPLOY-GAP.md`](PRIMARY-DEPLOY-GAP.md) — the manual steps after npm publish (global
258+
install upgrade + process restart) that this file does not cover, and the verification rule that
259+
applies until an operator performs them

0 commit comments

Comments
 (0)