fix(release): patch existing release notes by id

This commit is contained in:
Mohamed Boudra
2026-04-20 19:33:39 +07:00
parent 8d32167826
commit e09fd41adc
2 changed files with 96 additions and 23 deletions
+31 -23
View File
@@ -1,4 +1,4 @@
import { execFileSync } from "node:child_process";
import { execFileSync as nodeExecFileSync } from "node:child_process";
import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
@@ -117,21 +117,28 @@ function parseChangelog(changelogText) {
});
}
function hasRelease(tag, repo) {
function getRelease(tag, repo, execFileSync = nodeExecFileSync) {
try {
execFileSync("gh", ["release", "view", tag, "--repo", repo], {
stdio: "ignore",
const output = execFileSync("gh", ["api", `repos/${repo}/releases/tags/${tag}`], {
encoding: "utf8",
});
return true;
return JSON.parse(output);
} catch {
return false;
return null;
}
}
function runGh(args) {
function runGh(args, execFileSync = nodeExecFileSync) {
execFileSync("gh", args, { stdio: "inherit" });
}
function updateReleaseNotes({ releaseId, repo, notesPath }, execFileSync = nodeExecFileSync) {
runGh(
["api", "-X", "PATCH", `repos/${repo}/releases/${releaseId}`, "-F", `body=@${notesPath}`],
execFileSync,
);
}
function buildPrereleaseNotes({ releaseTag, version }) {
const today = new Date().toISOString().slice(0, 10);
const lines = [
@@ -150,8 +157,9 @@ function buildPrereleaseNotes({ releaseTag, version }) {
return `${lines.join("\n")}\n`;
}
function main() {
const args = parseArgs(process.argv.slice(2));
export function syncReleaseNotes(argv = process.argv.slice(2), deps = {}) {
const execFileSync = deps.execFileSync ?? nodeExecFileSync;
const args = parseArgs(argv);
const changelogPath = path.resolve("CHANGELOG.md");
const changelogText = readFileSync(changelogPath, "utf8");
const entries = parseChangelog(changelogText);
@@ -178,7 +186,6 @@ function main() {
const notesPath = path.join(tempDir, `${targetTag}-notes.md`);
writeFileSync(notesPath, notes);
const editArgs = ["release", "edit", targetTag, "--repo", args.repo, "--notes-file", notesPath];
const createArgs = [
"release",
"create",
@@ -194,16 +201,11 @@ function main() {
];
try {
if (hasRelease(targetTag, args.repo)) {
try {
runGh(editArgs);
console.log(`Updated release notes for ${targetTag}.`);
return;
} catch {
console.warn(
`Edit failed for ${targetTag} (release may have been recreated by another workflow); falling through to create.`,
);
}
const release = getRelease(targetTag, args.repo, execFileSync);
if (release) {
updateReleaseNotes({ releaseId: release.id, repo: args.repo, notesPath }, execFileSync);
console.log(`Updated release notes for ${targetTag}.`);
return;
}
if (!args.createIfMissing) {
@@ -214,13 +216,17 @@ function main() {
}
try {
runGh(createArgs);
runGh(createArgs, execFileSync);
console.log(`Created release ${targetTag} with changelog notes.`);
} catch (createError) {
console.warn(
`Release creation failed for ${targetTag}; attempting edit in case another workflow created it concurrently.`,
);
runGh(editArgs);
const raceRelease = getRelease(targetTag, args.repo, execFileSync);
if (!raceRelease) {
throw createError;
}
updateReleaseNotes({ releaseId: raceRelease.id, repo: args.repo, notesPath }, execFileSync);
console.log(`Updated release notes for ${targetTag} after create race.`);
if (createError instanceof Error) {
@@ -232,4 +238,6 @@ function main() {
}
}
main();
if (import.meta.url === `file://${process.argv[1]}`) {
syncReleaseNotes();
}