diff --git a/scripts/lib/release-notes.mjs b/scripts/lib/release-notes.mjs index e2234b00f..506f312af 100644 --- a/scripts/lib/release-notes.mjs +++ b/scripts/lib/release-notes.mjs @@ -365,6 +365,39 @@ export function verifyReleaseNotes(raw, text, body) { }; } +const VERSION_ONLY_PLUGIN_MANIFESTS = new Set([ + ".claude-plugin/plugin.json", + ".codex-plugin/plugin.json", +]); + +/** Serialize a plugin manifest with its release-owned version fields blanked. */ +function pluginManifestWithoutVersions(text) { + const manifest = JSON.parse(text); + if (manifest === null || typeof manifest !== "object") return text; + if ("version" in manifest) manifest.version = ""; + const launch = manifest.mcpServers?.rea?.args; + if (Array.isArray(launch) && launch.length > 1) launch[1] = ""; + return JSON.stringify(manifest); +} + +/** + * A plugin manifest also carries plugin behavior, so a release may change only + * its version and pinned server launch. Any other difference, an unreadable + * side, or a manifest added by the release counts as a product change. + */ +async function changesOnlyPluginVersions(run, path, from, to) { + try { + return ( + pluginManifestWithoutVersions( + await run("git", ["show", `${from}:${path}`]), + ) === + pluginManifestWithoutVersions(await run("git", ["show", `${to}:${path}`])) + ); + } catch { + return false; + } +} + /** Reject stale inventories and product changes made after the editorial target. */ export async function verifyInventoryHistory(run, raw, source) { const inventory = releaseInventorySchema.parse(raw); @@ -417,8 +450,6 @@ export async function verifyInventoryHistory(run, raw, source) { "package.json", "package-lock.json", "server.json", - ".claude-plugin/plugin.json", - ".codex-plugin/plugin.json", "src/generatedPackageMetadata.ts", "docs/installation.md", `docs/releases/${inventory.version}.contributions.json`, @@ -435,7 +466,16 @@ export async function verifyInventoryHistory(run, raw, source) { ) .split("\0") .filter(Boolean); - const product = paths.filter((path) => !allowed.has(path)); + const product = []; + for (const path of paths) { + if (allowed.has(path)) continue; + if ( + VERSION_ONLY_PLUGIN_MANIFESTS.has(path) && + (await changesOnlyPluginVersions(run, path, inventory.target, resolved)) + ) + continue; + product.push(path); + } if (product.length) throw new Error( `Product changed after notes target; regenerate inventory: ${product.join(", ")}`, diff --git a/tests/boundary/filesystem/releaseNotes.test.ts b/tests/boundary/filesystem/releaseNotes.test.ts index 00a2524d9..8fa86db37 100644 --- a/tests/boundary/filesystem/releaseNotes.test.ts +++ b/tests/boundary/filesystem/releaseNotes.test.ts @@ -43,6 +43,17 @@ interface ReleaseNotesSeed { let seed: ReleaseNotesSeed | undefined; let seedWorkspaceRoot: string | undefined; +const pluginManifests = [ + ".claude-plugin/plugin.json", + ".codex-plugin/plugin.json", +] as const; + +const pluginManifest = (version: string, skills = ["./skill"]) => ({ + version, + skills, + mcpServers: { rea: { args: ["-y", `rea-agents@${version}`, "mcp"] } }, +}); + beforeAll(async () => { const workspace = await createTestWorkspace("rea-release-notes-seed-"); seedWorkspaceRoot = workspace.root; @@ -58,6 +69,13 @@ beforeAll(async () => { join(directory, ".release-please-manifest.json"), JSON.stringify({ ".": "6.3.0" }), ); + for (const path of pluginManifests) { + await mkdir(join(directory, dirname(path)), { recursive: true }); + await writeFile( + join(directory, path), + JSON.stringify(pluginManifest("6.3.0")), + ); + } await git(directory, ["add", "."]); await git(directory, ["commit", "-m", "chore: baseline"]); const base = await git(directory, ["rev-parse", "HEAD"]); @@ -368,21 +386,15 @@ it("rejects lost grouped credits, fabricated references, bots, and stale PR bodi it("binds publication to complete recorded history and the reviewed base", async () => { const f = await fixture(); - const pluginManifests = [ - ".claude-plugin/plugin.json", - ".codex-plugin/plugin.json", - ]; - for (const path of pluginManifests) { - await mkdir(join(f.directory, dirname(path)), { recursive: true }); + for (const path of pluginManifests) await writeFile( join(f.directory, path), - JSON.stringify({ version: "6.4.0" }), + JSON.stringify(pluginManifest("6.4.0")), ); - } await git(f.directory, ["add", "CHANGELOG.md", ...pluginManifests]); await git(f.directory, ["commit", "-m", "chore: release notes"]); const source = await git(f.directory, ["rev-parse", "HEAD"]); - // Release PRs bump the plugin manifest versions, so they are release-only metadata. + // Release PRs bump the plugin manifest version and pinned launch only. await f.invoke(["check", "--manifest", f.manifest, "--source", source]); await writeFile(join(f.directory, "product.txt"), "later product change"); await git(f.directory, ["add", "product.txt"]); @@ -403,6 +415,26 @@ it("binds publication to complete recorded history and the reviewed base", async }); }); +it.each(pluginManifests)( + "treats a release that changes plugin behavior in %s as a product change", + async (path) => { + const f = await fixture(); + await writeFile( + join(f.directory, path), + JSON.stringify(pluginManifest("6.4.0", ["./another-skill"])), + ); + await git(f.directory, ["add", "CHANGELOG.md", path]); + await git(f.directory, ["commit", "-m", "chore: release notes"]); + await expect( + f.invoke(["check", "--manifest", f.manifest, "--source", "HEAD"]), + ).rejects.toMatchObject({ + stderr: expect.stringContaining( + `Product changed after notes target; regenerate inventory: ${path}`, + ), + }); + }, +); + it("checks the live merged PR and exact Git snapshot before either publication route", async () => { const f = await fixture(); await mkdir(join(f.directory, "docs/releases"), { recursive: true });