fix(release): patch existing release notes by id

2026-04-20 19:33:39 +07:00
parent 8d32167826
commit e09fd41adc
2 changed files with 96 additions and 23 deletions
@@ -0,0 +1,65 @@
+import assert from "node:assert/strict";
+import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import test from "node:test";
+import { syncReleaseNotes } from "./sync-release-notes-from-changelog.mjs";
+
+function withTempChangelog(fn) {
+  const previousCwd = process.cwd();
+  const tempDir = mkdtempSync(path.join(tmpdir(), "paseo-release-notes-test-"));
+  process.chdir(tempDir);
+  writeFileSync("CHANGELOG.md", "## 0.1.60 - 2026-04-20\n\n- Stable notes.\n");
+
+  try {
+    fn();
+  } finally {
+    process.chdir(previousCwd);
+    rmSync(tempDir, { force: true, recursive: true });
+  }
+}
+
+test("updates an existing release body through the release id API", () => {
+  withTempChangelog(() => {
+    const calls = [];
+
+    const execFileSync = (command, args, options) => {
+      calls.push({ args, command, options });
+
+      if (args[0] === "api" && args[1] === "repos/getpaseo/paseo/releases/tags/v0.1.60-rc.3") {
+        return JSON.stringify({ id: 311163621 });
+      }
+
+      if (args[0] === "api" && args[1] === "-X" && args[2] === "PATCH") {
+        const notesArg = args.find((arg) => arg.startsWith("body=@"));
+        assert.ok(notesArg, "PATCH should send the notes body from a file");
+        const notesPath = notesArg.slice("body=@".length);
+        assert.match(notesPath, /v0\.1\.60-rc\.3-notes\.md$/);
+        return "";
+      }
+
+      throw new Error(`Unexpected gh call: ${command} ${args.join(" ")}`);
+    };
+
+    syncReleaseNotes(["--repo", "getpaseo/paseo", "--tag", "v0.1.60-rc.3"], {
+      execFileSync,
+    });
+
+    assert.equal(
+      calls.some((call) => call.args[0] === "release" && call.args[1] === "edit"),
+      false,
+      "retagged releases should not use gh release edit because it can resend tag_name",
+    );
+    assert.equal(
+      calls.some(
+        (call) =>
+          call.args[0] === "api" &&
+          call.args[1] === "-X" &&
+          call.args[2] === "PATCH" &&
+          call.args[3] === "repos/getpaseo/paseo/releases/311163621",
+      ),
+      true,
+      "existing releases should be patched by release id",
+    );
+  });
+});