Commit 734e13f
authored
docs: add a no-credential quickstart for landing a change (#591)
## Summary
### Why?
The on-ramp jumped straight from "Ping returns" to "get a scratch
repository and a GitHub token". Nothing in between showed the queue
doing the thing it exists to do, even though the local stack has been
able to land a change with no credentials all along — every integration
at the edges is faked, so a request walks the whole pipeline in seconds
and settles at `landed`.
The Ping step it stopped at did not work either. The gateway registers
reflection, but its descriptor references
`api/base/change/proto/change.proto` while the generated `change.pb.go`
registers that file as plain `change.proto`, so reflection cannot
resolve the service and `grpcurl` refuses every method on it. The
`grpcurl` invocation in both README.md and DEVELOPMENT.md therefore
failed for anyone who ran it.
`service/submitqueue/demo/provider/local/` looked like the natural home
for this, but it is not reachable by hand: `make local-provider-start
PROVIDER=local` layers `docker-compose.provider.yml`, which
hard-requires `GITHUB_TOKEN`, and the overlay it actually wants needs a
bare repository the E2E harness provisions. Making that runnable is a
Makefile change rather than a docs change, so this keeps to what already
runs.
### What?
A new [doc/howto/QUICKSTART.md](doc/howto/QUICKSTART.md): start the
stack, discover the gateway's port, land a change, follow it to
`landed`, then make one fail on demand with a `?sq-fake=build-fail`
marker and watch a good change land behind it. It covers the two things
that reject a request outright — a 40-hex commit SHA and a
percent-encoded `refs/…` ref — and is explicit that faking the edges is
what makes the run free and what stops `landed` from proving a commit
reached a branch.
README.md's Quick Start becomes that run in six commands, replacing the
broken `grpcurl` line, and DEVELOPMENT.md's "Try It Locally" matches.
Both link on to `make e2e-git-test` and PROVIDER-E2E.md as the tiers
that add a real merge and a real provider.
PROVIDER-E2E.md carried a stale claim that the finer statuses "are never
published", so a request "sits on `batched` for the whole of its active
life". The request log disagrees: `accepted → started → validating →
validated → batched → speculating → speculated → landing → landed`, with
`building` and `built` recorded as events. That paragraph, the sentence
repeating it further down, and the sample table above it are corrected.
Two defects surfaced while verifying this and are documented but **not**
fixed here, since both are code changes:
- the reflection descriptor mismatch above, which makes `grpcurl`
unusable against the gateway;
- both MySQL services mount *anonymous* volumes, so every stop/start
cycle orphans a pair and comes back to an empty database — `make
local-stop` reports "Data volumes preserved", which is true of the
volumes and not of the data. It is also why the volumes accumulate until
Docker runs out of disk.
## Test Plan
Every command in the quickstart was run against a live stack, and the
documented output is what it printed.
- ✅ `make local-submitqueue-start`, then the documented `make land` /
`make land-status` — reached `landed`
- ✅ the same URI with `?sq-fake=build-fail` — terminal `error`
- ✅ a failing change and a good one in flight together — the first went
`error`, the second still reached `landed`
- ✅ the trail in both the `request_log` table and `make land-watch`,
which is what the corrected PROVIDER-E2E.md paragraph now states
- ✅ re-ran the whole documented sequence from a torn-down stack,
confirming the port really is different each time and that
`test-queue/1` is reproducible
Not verified: the wrapping of the sample table in PROVIDER-E2E.md, which
comes from `make demo-pr` and needs a token. Only the status names in it
were corrected; it remains illustrative.1 parent ab9e75f commit 734e13f
4 files changed
Lines changed: 176 additions & 20 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
| 21 | + | |
28 | 22 | | |
29 | 23 | | |
30 | | - | |
31 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
38 | 40 | | |
39 | 41 | | |
40 | 42 | | |
41 | 43 | | |
42 | 44 | | |
| 45 | + | |
43 | 46 | | |
44 | 47 | | |
45 | 48 | | |
| 49 | + | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
| 54 | + | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
| 65 | + | |
65 | 66 | | |
66 | | - | |
67 | | - | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
68 | 71 | | |
69 | 72 | | |
70 | 73 | | |
71 | 74 | | |
72 | 75 | | |
| 76 | + | |
| 77 | + | |
73 | 78 | | |
74 | 79 | | |
75 | 80 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
110 | 110 | | |
111 | 111 | | |
112 | 112 | | |
113 | | - | |
114 | | - | |
115 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
116 | 118 | | |
117 | 119 | | |
118 | 120 | | |
119 | 121 | | |
120 | 122 | | |
121 | 123 | | |
122 | 124 | | |
123 | | - | |
| 125 | + | |
124 | 126 | | |
125 | 127 | | |
126 | 128 | | |
| |||
151 | 153 | | |
152 | 154 | | |
153 | 155 | | |
154 | | - | |
| 156 | + | |
155 | 157 | | |
156 | 158 | | |
157 | 159 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
0 commit comments