You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 72ad22c
Browse filesBrowse the repository at this point in the historyBrowse files
@@ -26,15 +26,18 @@ things safe to say in public about the backlog are **aggregate counts** (how
26
26
many are in each state). A branch named after the bug, or a commit message that
27
27
describes it, discloses it as surely as an issue would.
28
28
29
-
Related: `/board-ops` holds the board IDs and the draft-card recipes, and
30
-
`/issue-create` gives public tracking its labels and milestone **after
31
-
publication**, never merely after the release (step 6).
32
-
33
-
⚠️ **The PR flow does not apply to the fix itself.** It needs a public issue
34
-
and a public PR against `v2/main`, which is the disclosure this flow exists to
35
-
delay. The fix is reviewed inside the private fork (step 4), and `AGENTS.md`
36
-
records that fork PR as an exception to its PR rules (no public issue link, no
37
-
labels, tracked by the draft card).
29
+
Related: `/board-ops` holds the board IDs and the draft-card recipes,
30
+
`/issue-create` gives the converted issue its labels and milestone (step 5),
31
+
and `/pr-flow` opens the public PR that brings the fix to `v2/main` (step 5).
32
+
33
+
⚠️ **The fix is written and reviewed in the private fork, then merged through
34
+
an opaque public PR.** The fork's PR (step 4) links no public issue, carries no
35
+
labels and is tracked by the draft card; it is never merged. When the fix is
36
+
ready to merge, the card converts to an issue that keeps its opaque title, and
37
+
a public PR from the same opaque branch closes it (step 5). That PR follows
38
+
`/pr-flow` except that **nothing in it describes the vulnerability** and it
39
+
gets **no Copilot review**. `AGENTS.md` records both PRs as an exception to
40
+
its PR rules.
38
41
39
42
## The flow
40
43
@@ -44,8 +47,8 @@ labels, tracked by the draft card).
44
47
| 2 |**Verify the claim**: which server, and does the code belong to it or to an SDK? | Judgment |
45
48
| 3 | Valid and ours → **accept** (`triage` → `draft`); otherwise close with a reason |**Human only**|
46
49
| 4 | Create the **private fork**, fix and review there | Mechanical |
47
-
| 5 |Merge to `v2/main`, milestone merge, **release**, close the fork's PR, then **publish**|**Human only**(closing the fork's PR is mechanical) |
48
-
| 6 |**After publication**, convert the draft card into a public issue| Mechanical |
50
+
| 5 |Close to the release: **convert the card** to an opaque issue, open the opaque **public PR**, merge it, close the fork's PR; then milestone merge, **release**, **publish**|**Human only**for merging, releasing and publishing (converting, the PR and closing the fork's PR are mechanical) |
51
+
| 6 |**After publication**, give the issue its public title and the advisory link| Mechanical |
49
52
50
53
There is **one release line**. Every fix lands on `v2/main` and ships through
51
54
the next milestone merge to `main` and a release, as any other change does
@@ -197,7 +200,8 @@ moves the advisory `triage` → `draft`. The API shows it as `state` and
197
200
normally assigning a milestone, and a draft card cannot carry one, so for an
198
201
advisory draft **accepting the advisory is the approval**. `AGENTS.md` records
199
202
this as the advisory exemption to its `Incoming` ⇔ milestone rule. The milestone
200
-
arrives with the public issue in step 6, where the ordinary rule resumes.
203
+
arrives when the card converts to an issue in step 5, where the ordinary rule
204
+
resumes.
201
205
202
206
**Invalid, out of scope, a duplicate, or an SDK's → close** with a comment
203
207
saying which, and why; for an SDK's, say where it was routed. A reporter who is
@@ -249,8 +253,10 @@ any other change: a regression test that fails before the fix, and the gate
249
253
under **Before pushing**. Name the branch
250
254
`v2/fix/<ghsa-id>` (lowercase, **no descriptive slug**, since a branch name
251
255
outlives the fork once merged), and keep commit messages equally opaque until
252
-
publication. **The fork's PR targets `v2/main`**, never `main`: check its base
253
-
before anyone merges it.
256
+
publication. **The fork's PR targets `v2/main`**, never `main`, so the diff
257
+
reviewed there is the diff that lands. It is where the review happens; it is
258
+
**not merged**. The same branch is pushed to this repository and merged
259
+
through a public PR (step 5), and the fork's PR is then closed.
254
260
255
261
⚠️ **Move the card as the work moves.**`In Progress` when the fix is started,
256
262
`In Review` when the fork's PR is open. The fork is invisible to everyone not on
@@ -290,8 +296,10 @@ body nobody will read again.
290
296
already accepted, and asking for the work approves it. Otherwise it goes in
291
297
`Incoming`. Score its Priority with step 1's table, using the severity of the
292
298
residual exposure rather than the advisory's.
293
-
-**Say in the fix PR's body what the fix leaves open**, and link the
294
-
follow-up. The advisory's text must say it too when it is published (step 5).
299
+
-**Say in the fork PR's body what the fix leaves open**, and name the
300
+
follow-up card. The public PR (step 5) says nothing about it, since
301
+
describing the gap describes the vulnerability. The advisory's text must say
302
+
it too when it is published (step 5).
295
303
296
304
Create it with `/board-ops`'s draft-card recipe, using the follow-up title in
297
305
place of `[$GHSA]`.
@@ -308,35 +316,114 @@ of three cases:
308
316
- It is non-security work outside the advisory's scope, which gets a public
309
317
issue **after publication**, like any other finding.
310
318
311
-
### 5. Merge, release, publish (human only)
319
+
### 5. Bring the fix to `v2/main`, release, publish
312
320
313
321
Publish **after** the fix has shipped in a release, never before: publishing
314
322
discloses the vulnerability, and doing it while users have no upgrade hands out
315
323
a working exploit. **Shipped** means the fixed version of that server is on npm
316
324
or PyPI.
317
325
318
-
⚠️ **The patch stops being secret at MERGE, not at publish.** Merging the fork
319
-
puts an ordinary public commit on `v2/main`, readable by anyone, and it then
320
-
travels through the milestone merge to `main` before `release.yml` publishes it.
321
-
The time between merge and publish is not a period of secrecy; it is a period
322
-
of **exposure to anyone reading commits**, so keep it short: merge close to the
323
-
release, and publish as soon as the release is out.
326
+
⚠️ **The patch stops being secret when its branch reaches this repository, not
327
+
at publish.** Pushing the fork's branch here (below) makes its commits readable
328
+
by anyone, the public PR shows the diff, and the merge then travels through the
329
+
milestone merge to `main` before `release.yml` publishes it. The time between
330
+
that push and the publish is not a period of secrecy; it is a period of
331
+
**exposure to anyone reading commits**, so keep it short: start this step close
332
+
to the release, merge as soon as CI passes, and publish as soon as the release
333
+
is out.
324
334
325
335
The release itself is a maintainer action (`release.yml` runs only when a
326
336
maintainer publishes a GitHub Release, behind the `release` environment's
327
337
approval; see [`RELEASING.md`](../../../RELEASING.md)). Say which server needs a release and
328
338
stop there.
329
339
330
-
⚠️ **Publishing is irreversible and human-only.** It makes the advisory public,
331
-
with no undo. Same rule as accepting: recommend, never perform.
340
+
⚠️ **Merging, releasing and publishing are human-only.** Publishing is also
341
+
irreversible: it makes the advisory public, with no undo. Same rule as
342
+
accepting: recommend, never perform. Converting the card, opening the public
343
+
PR and closing the fork's PR are mechanical.
344
+
345
+
#### Convert the card to an opaque issue
346
+
347
+
When the fix's review in the fork is done and the release is near, convert the
348
+
draft card to an issue, so the public PR has an issue to close and a card that
349
+
tracks it.
350
+
351
+
⚠️ **Convert the draft; do not file a new issue.** "Convert to issue" creates a
352
+
**new** issue from the draft card, and there is no way to point an existing card
353
+
at an issue filed separately, so filing by hand and then converting produces two
354
+
issues and two cards.
355
+
356
+
1.**Keep the opaque title**, `[GHSA-xxxx-yyyy-zzzz]`, and the
357
+
link-and-triage body (step 1). The issue takes the card's title and body,
358
+
and the advisory is still private, so no summary may appear yet (step 6
359
+
adds it). The advisory link in the body opens only for people on the
360
+
advisory.
361
+
2.**Convert the draft card to an issue** in `modelcontextprotocol/servers`
362
+
(the card keeps its place and its field values). The recipe is in
363
+
`/board-ops`.
364
+
3. Apply the labels and milestone from `/issue-create` (steps 1 and 2): `v2`,
365
+
one type label (normally `bug`), the server's scope label, and the milestone
366
+
of the release the fix will ship in. **Skip its board step**: the converted
367
+
card is already on #43.
368
+
369
+
A **follow-up card stays a draft** here: its write-up describes the gap, so it
370
+
converts only after publication (step 6).
371
+
372
+
#### Open the public PR
373
+
374
+
Push the fork's branch to this repository under the **same opaque name**,
375
+
`v2/fix/<ghsa-id>`, and open the PR with `/pr-flow` steps 4 and 6. The fork has
0 commit comments