Skip to content

Commit 8d40eb2

Browse files
authored
Merge pull request #5132 from modelcontextprotocol/v2/chore/5115-release-notes-ledger-placement
release:notes: put the release-ledger line under the Packages table
2 parents c32f931 + c059fb6 commit 8d40eb2

3 files changed

Lines changed: 19 additions & 10 deletions

File tree

‎.claude/skills/release/SKILL.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -437,14 +437,16 @@ what changed in the server they use:
437437
whether this release publishes it (the registry does not have that version
438438
yet) or leaves it unchanged. The tag is the milestone's name, not a
439439
version, so this table is where a reader finds the versions.
440-
2. **One `## <package> <version>` section per published package**, whose
440+
2. **The release-ledger line**, linking the artifact from 4d, directly under
441+
the table, so what was published and the evidence behind it are read
442+
together.
443+
3. **One `## <package> <version>` section per published package**, whose
441444
`### What's Changed` lists the PRs that change files under its
442445
`src/<dir>/`. A PR that touches several servers is listed under each.
443-
3. **`## Repository`**: every PR no published section took (CI, docs, skills,
446+
4. **`## Repository`**: every PR no published section took (CI, docs, skills,
444447
a server whose version did not change), so no PR in the generated list is
445448
dropped.
446-
4. GitHub's **New Contributors** block and **Full Changelog** link, verbatim.
447-
5. **The release-ledger line**, linking the artifact from 4d.
449+
5. GitHub's **New Contributors** block and **Full Changelog** link, verbatim.
448450
6. **`## Known issues`**, only when you pass one. It names the issue, who is
449451
affected and the workaround. What counts as a known issue is a maintainer's
450452
judgment, so it is written by hand, never generated.

‎scripts/release-notes.mjs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@
1111
//
1212
// ## Packages every package, its version, and whether
1313
// this release publishes it (registry check)
14+
// Release ledger: [<branch>](<url>) right under the table, so what was
15+
// published and the evidence behind it are
16+
// read together, not below every PR list
1417
// ## <package> <version> one per PUBLISHED package, with its
1518
// ### What's Changed PRs
1619
// ## Repository every PR left over (CI, docs, skills, a
1720
// server whose version did not change), so
1821
// no PR in the generated list is dropped
1922
// ## New Contributors / Full Changelog GitHub's own trailer, verbatim
20-
// Release ledger: [<branch>](<url>)
2123
// ## Known issues only when passed in: a maintainer's call
2224
// ## Thanks for helping us improve one release-wide list of the community
2325
// members whose issues the PRs close, laid
@@ -569,9 +571,9 @@ export function assembleNotes({
569571
return (
570572
[
571573
packages,
574+
`Release ledger: [${mergeBranch}](${ledgerUrl})`,
572575
...sections,
573576
trailer,
574-
`Release ledger: [${mergeBranch}](${ledgerUrl})`,
575577
formatKnownIssues(knownIssues),
576578
thanks,
577579
]

‎scripts/release-notes.test.mjs‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ test("formatKnownIssues pluralizes and is omitted when empty", () => {
287287
assert.equal(formatKnownIssues(["a", "b"]), "## Known issues\n\na\n\nb");
288288
});
289289

290-
test("assembleNotes: packages, sections, trailer, ledger, known issues, thanks", () => {
290+
test("assembleNotes: packages, ledger, sections, trailer, known issues, thanks", () => {
291291
assert.equal(
292292
assembleNotes({
293293
packages: "P",
@@ -298,7 +298,7 @@ test("assembleNotes: packages, sections, trailer, ledger, known issues, thanks",
298298
knownIssues: ["K"],
299299
thanks: "## Thanks for helping us improve\n\nX",
300300
}),
301-
"P\n\nS1\n\nS2\n\nT\n\nRelease ledger: [mb](https://l)\n\n## Known issue\n\nK\n\n## Thanks for helping us improve\n\nX\n",
301+
"P\n\nRelease ledger: [mb](https://l)\n\nS1\n\nS2\n\nT\n\n## Known issue\n\nK\n\n## Thanks for helping us improve\n\nX\n",
302302
);
303303
assert.equal(
304304
assembleNotes({
@@ -528,6 +528,13 @@ test("notes: per-server sections, every PR placed, one release-wide Thanks", asy
528528
"## Repository",
529529
"## Thanks for helping us improve",
530530
]);
531+
// The ledger sits directly under the Packages table (#5115), so the
532+
// evidence for what was published is read with it, not below every PR list.
533+
assert.match(
534+
sectionOf(notes, "## Packages"),
535+
/\|\n\nRelease ledger: \[v2\/chore\/1-release-v2\.0\.0\]\(https:\/\/l\.example\/x\)\n$/,
536+
);
537+
assert.equal(notes.split("Release ledger:").length, 2);
531538

532539
const git = sectionOf(notes, "## mcp-server-git 2.0.0");
533540
assert.match(git, /change 10 .*\n\* change 11 [^\n]*\n*$/);
@@ -550,8 +557,6 @@ test("notes: per-server sections, every PR placed, one release-wide Thanks", asy
550557
[
551558
"**Full Changelog**: https://example/compare",
552559
"",
553-
"Release ledger: [v2/chore/1-release-v2.0.0](https://l.example/x)",
554-
"",
555560
"## Thanks for helping us improve",
556561
"",
557562
THANKS_LEAD_IN,

0 commit comments

Comments
 (0)