mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
476b48a7d6
release-notes.md and release-notes-notion.json were both gitignored, so create-pull-request silently skipped them. The notes never reached the release branch, the publish job's readFileSync missed, and every release since this lane was built shipped its "Release <tag>" fallback body — v1.70.0, channels/v0.6.0 and angular/v0.4.0 all have bodyless GitHub Releases. The same ignore rule severed the Notion lane: without the json ref in the checkout, publish-release could never read an edited draft back, so that path had never run either. Remove it rather than repair it — the release PR is already the review surface, and editing release-notes.md on the branch is a plainer gate than a Notion page. Guard the ignore rule with a test, since re-adding it would break the lane again without breaking anything else.
149 lines
4.4 KiB
TypeScript
149 lines
4.4 KiB
TypeScript
/**
|
|
* AI-powered release notes generator.
|
|
*
|
|
* 1. Reads the raw changelog from release-notes.md
|
|
* 2. Calls Claude API to generate polished release notes
|
|
* 3. Writes release-notes.md with the AI version
|
|
*
|
|
* release-notes.md is committed to the release PR branch, which is both the
|
|
* review surface and how the notes reach the publish job.
|
|
*
|
|
* Env vars:
|
|
* ANTHROPIC_API_KEY — for AI generation (falls back to raw if missing)
|
|
*
|
|
* Usage: tsx scripts/release/generate-ai-release-notes.ts <version>
|
|
*/
|
|
|
|
import fs from "fs";
|
|
import path from "path";
|
|
import https from "https";
|
|
import { spawnSync } from "child_process";
|
|
import { ROOT } from "./lib/config.js";
|
|
import { GIT_LOG_FORMAT, parseCommitLog } from "./lib/changes.js";
|
|
|
|
function getRecentCommits(count = 50): string {
|
|
const result = spawnSync(
|
|
"git",
|
|
["log", `-${count}`, "--no-merges", `--format=${GIT_LOG_FORMAT}`],
|
|
{ cwd: ROOT, encoding: "utf8" },
|
|
);
|
|
return parseCommitLog(result.stdout)
|
|
.map((commit) =>
|
|
[
|
|
`commit ${commit.hash.slice(0, 7)}`,
|
|
`subject: ${commit.subject}`,
|
|
commit.body ? `body:\n${commit.body}` : "",
|
|
]
|
|
.filter(Boolean)
|
|
.join("\n"),
|
|
)
|
|
.join("\n\n");
|
|
}
|
|
|
|
function callAnthropic(apiKey: string, prompt: string): Promise<string> {
|
|
return new Promise((resolve, reject) => {
|
|
const body = JSON.stringify({
|
|
model: "claude-opus-4-8",
|
|
max_tokens: 2048,
|
|
messages: [{ role: "user", content: prompt }],
|
|
});
|
|
|
|
const options = {
|
|
hostname: "api.anthropic.com",
|
|
path: "/v1/messages",
|
|
method: "POST",
|
|
headers: {
|
|
"Content-Type": "application/json",
|
|
"x-api-key": apiKey,
|
|
"anthropic-version": "2023-06-01",
|
|
},
|
|
};
|
|
|
|
const req = https.request(options, (res) => {
|
|
let data = "";
|
|
res.on("data", (chunk: string) => (data += chunk));
|
|
res.on("end", () => {
|
|
try {
|
|
const parsed = JSON.parse(data);
|
|
if (parsed.content?.[0]) {
|
|
resolve(parsed.content[0].text);
|
|
} else {
|
|
reject(new Error(`Unexpected API response: ${data}`));
|
|
}
|
|
} catch (e) {
|
|
reject(e);
|
|
}
|
|
});
|
|
});
|
|
|
|
req.on("error", reject);
|
|
req.write(body);
|
|
req.end();
|
|
});
|
|
}
|
|
|
|
async function main() {
|
|
const version = process.argv[2];
|
|
if (!version) {
|
|
console.error("Usage: generate-ai-release-notes.ts <version>");
|
|
process.exit(1);
|
|
}
|
|
|
|
const releaseNotesPath = path.join(ROOT, "release-notes.md");
|
|
if (!fs.existsSync(releaseNotesPath)) {
|
|
console.error("release-notes.md not found. Run prepare-release.ts first.");
|
|
process.exit(1);
|
|
}
|
|
|
|
const rawChangelog = fs.readFileSync(releaseNotesPath, "utf8");
|
|
let finalNotes = rawChangelog;
|
|
|
|
// Step 1: AI-enhance the release notes if API key is available
|
|
const anthropicKey = process.env.ANTHROPIC_API_KEY;
|
|
if (anthropicKey) {
|
|
console.log("Generating AI-enhanced release notes...");
|
|
const recentCommits = getRecentCommits();
|
|
|
|
const prompt = `You are writing release notes for CopilotKit v${version}, an open-source AI agent framework for React applications.
|
|
|
|
Here is the raw changelog extracted from git history:
|
|
|
|
${rawChangelog}
|
|
|
|
Here are the recent git commits, including their bodies, for additional context:
|
|
|
|
${recentCommits}
|
|
|
|
Write polished, user-facing release notes for a GitHub Release. Guidelines:
|
|
- Start with a brief (1-2 sentence) summary of the release
|
|
- Group changes into clear sections (Features, Fixes, Breaking Changes as applicable)
|
|
- Write in a professional but approachable tone
|
|
- Focus on what users care about — what changed and why it matters
|
|
- Include any migration notes for breaking changes
|
|
- Keep it concise — no filler, no marketing speak
|
|
- Use markdown formatting
|
|
- Do NOT include a title/header — the GitHub Release title will be "v${version}"
|
|
|
|
Output ONLY the release notes content, nothing else.`;
|
|
|
|
try {
|
|
finalNotes = await callAnthropic(anthropicKey, prompt);
|
|
fs.writeFileSync(releaseNotesPath, finalNotes);
|
|
console.log("AI-enhanced release notes written to release-notes.md");
|
|
} catch (err: any) {
|
|
console.error(`AI generation failed: ${err.message}`);
|
|
console.log("Falling back to raw changelog.");
|
|
}
|
|
} else {
|
|
console.log(
|
|
"No ANTHROPIC_API_KEY found. Using raw changelog as release notes.",
|
|
);
|
|
}
|
|
|
|
}
|
|
|
|
main().catch((err) => {
|
|
console.error(err);
|
|
process.exit(1);
|
|
});
|