返回 DeepSeek-Reasonix
release-notes.mjs
根目录 / scripts / release-notes.mjs
1 #!/usr/bin/env node
2
3 import { readFile, writeFile } from "node:fs/promises";
4 import { dirname, resolve } from "node:path";
5 import { fileURLToPath } from "node:url";
6
7 const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
8 export const defaultCatalogPath = resolve(repoRoot, "release-notes/releases.json");
9
10 const localizedFields = ["title", "body"];
11 const changeKinds = ["new", "improved", "fixed"];
12 const itemKinds = new Set(["new", "improved", "fixed", "security"]);
13 const releaseChannels = new Set(["stable", "prerelease"]);
14 const releaseStatuses = new Set(["reviewed", "published"]);
15 const releaseTargetOrder = ["desktop", "cli", "site", "service"];
16 const releaseTargets = new Set(releaseTargetOrder);
17 const releaseTargetingRequiredFrom = "1.31.4";
18
19 function invariant(condition, message) {
20 if (!condition) throw new Error(message);
21 }
22
23 function isObject(value) {
24 return value !== null && typeof value === "object" && !Array.isArray(value);
25 }
26
27 function validateLocalized(value, path) {
28 invariant(isObject(value), `${path} must be an object`);
29 for (const lang of ["en", "zh"]) {
30 invariant(typeof value[lang] === "string" && value[lang].trim(), `${path}.${lang} must be a non-empty string`);
31 }
32 }
33
34 function validateRefs(refs, path) {
35 if (refs === undefined) return;
36 invariant(Array.isArray(refs), `${path} must be an array`);
37 for (const ref of refs) invariant(Number.isInteger(ref) && ref > 0, `${path} contains invalid PR number ${ref}`);
38 }
39
40 function validateItem(item, path, { kind = false, href = false, level = false, targets = false } = {}) {
41 invariant(isObject(item), `${path} must be an object`);
42 for (const field of localizedFields) validateLocalized(item[field], `${path}.${field}`);
43 if (kind) invariant(itemKinds.has(item.kind), `${path}.kind is invalid`);
44 if (href) invariant(typeof item.href === "string" && /^https:\/\//.test(item.href), `${path}.href must be HTTPS`);
45 if (level) invariant(item.level === "info" || item.level === "warning", `${path}.level is invalid`);
46 if (targets || item.targets !== undefined) {
47 invariant(Array.isArray(item.targets) && item.targets.length > 0, `${path}.targets must be a non-empty array`);
48 invariant(new Set(item.targets).size === item.targets.length, `${path}.targets contains duplicates`);
49 for (const target of item.targets) invariant(releaseTargets.has(target), `${path}.targets contains invalid target ${target}`);
50 const sorted = releaseTargetOrder.filter((target) => item.targets.includes(target));
51 invariant(sorted.every((target, index) => target === item.targets[index]), `${path}.targets must use canonical order`);
52 }
53 validateRefs(item.refs, `${path}.refs`);
54 }
55
56 function releaseItems(release) {
57 return [
58 ...release.highlights,
59 ...changeKinds.flatMap((kind) => release.changes[kind]),
60 ...release.upgrade,
61 ...release.risks,
62 ];
63 }
64
65 function itemTargetsUnion(release) {
66 const targets = new Set(releaseItems(release).flatMap((item) => item.targets || []));
67 return releaseTargetOrder.filter((target) => targets.has(target));
68 }
69
70 function semverParts(version) {
71 const match = String(version).match(/^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?$/);
72 invariant(match, `invalid version ${version}`);
73 return [Number(match[1]), Number(match[2]), Number(match[3]), match[4] || ""];
74 }
75
76 function isCoreVersionAtLeast(version, minimum) {
77 const current = semverParts(version);
78 const floor = semverParts(minimum);
79 for (let index = 0; index < 3; index += 1) {
80 if (current[index] !== floor[index]) return current[index] > floor[index];
81 }
82 return true;
83 }
84
85 export function compareVersionsDesc(a, b) {
86 const aa = semverParts(a);
87 const bb = semverParts(b);
88 for (let i = 0; i < 3; i += 1) {
89 if (aa[i] !== bb[i]) return bb[i] - aa[i];
90 }
91 if (aa[3] === bb[3]) return 0;
92 if (!aa[3]) return -1;
93 if (!bb[3]) return 1;
94 return String(bb[3]).localeCompare(String(aa[3]), "en", { numeric: true });
95 }
96
97 export function validateCatalog(catalog) {
98 invariant(isObject(catalog), "catalog must be an object");
99 invariant(catalog.schemaVersion === 1, "catalog.schemaVersion must be 1");
100 invariant(Array.isArray(catalog.releases) && catalog.releases.length > 0, "catalog.releases must not be empty");
101
102 const versions = new Set();
103 for (const [index, release] of catalog.releases.entries()) {
104 const path = `releases[${index}]`;
105 invariant(isObject(release), `${path} must be an object`);
106 semverParts(release.version);
107 invariant(!versions.has(release.version), `duplicate version ${release.version}`);
108 versions.add(release.version);
109 invariant(/^\d{4}-\d{2}-\d{2}$/.test(release.date), `${path}.date must use YYYY-MM-DD`);
110 invariant(releaseChannels.has(release.channel), `${path}.channel is invalid`);
111 if (release.releaseId !== undefined) {
112 invariant(release.releaseId === release.version, `${path}.releaseId must equal version`);
113 }
114 if (release.baseVersion !== undefined) {
115 semverParts(release.baseVersion);
116 invariant(!release.baseVersion.includes("-"), `${path}.baseVersion must be stable semver`);
117 invariant(
118 release.version === release.baseVersion || release.version.startsWith(`${release.baseVersion}-`),
119 `${path}.baseVersion does not match version`,
120 );
121 }
122 if (release.status !== undefined) {
123 invariant(releaseStatuses.has(release.status), `${path}.status is invalid`);
124 }
125 if (release.candidateSha !== undefined) {
126 invariant(/^[0-9a-f]{40}$/.test(release.candidateSha), `${path}.candidateSha must be a full commit SHA`);
127 }
128 if (release.previousRelease !== undefined) {
129 semverParts(release.previousRelease);
130 invariant(release.previousRelease !== release.version, `${path}.previousRelease must differ from version`);
131 }
132 if (release.builds !== undefined) {
133 invariant(isObject(release.builds), `${path}.builds must be an object`);
134 for (const surface of ["cli", "desktop", "npm"]) {
135 invariant(
136 typeof release.builds[surface] === "string" && release.builds[surface].trim(),
137 `${path}.builds.${surface} must be a non-empty string`,
138 );
139 }
140 }
141 if (release.status !== undefined) {
142 for (const field of ["releaseId", "baseVersion", "previousRelease", "builds"]) {
143 invariant(release[field] !== undefined, `${path}.${field} is required for managed release records`);
144 }
145 if (release.channel === "stable") {
146 invariant(release.version === release.baseVersion, `${path}.stable version must equal baseVersion`);
147 invariant(release.builds.cli === `v${release.version}`, `${path}.builds.cli does not match Stable version`);
148 invariant(release.builds.desktop === `v${release.version}`, `${path}.builds.desktop does not match Stable version`);
149 invariant(release.builds.npm === release.version, `${path}.builds.npm does not match Stable version`);
150 } else {
151 const preview = release.version.match(/^(\d+\.\d+\.\d+)-preview\.([1-9][0-9]*)$/);
152 invariant(preview, `${path}.managed prerelease must use MAJOR.MINOR.PATCH-preview.N`);
153 invariant(preview[1] === release.baseVersion, `${path}.Preview baseVersion does not match version`);
154 invariant(release.builds.cli === `v${release.version}`, `${path}.builds.cli does not match Preview version`);
155 invariant(release.builds.desktop === `v${release.version}`, `${path}.builds.desktop does not match Preview version`);
156 invariant(
157 release.builds.npm === `${release.baseVersion}-canary.${preview[2]}`,
158 `${path}.builds.npm does not match Preview ordinal`,
159 );
160 }
161 }
162 const targetingRequiredByVersion = isCoreVersionAtLeast(release.version, releaseTargetingRequiredFrom);
163 if (targetingRequiredByVersion) {
164 invariant(
165 release.targetingVersion === 1,
166 `${path}.targetingVersion must be 1 for v${releaseTargetingRequiredFrom} and newer`,
167 );
168 } else if (release.targetingVersion !== undefined) {
169 invariant(release.targetingVersion === 1, `${path}.targetingVersion is invalid`);
170 }
171 const targetsRequired = release.targetingVersion === 1;
172 validateLocalized(release.title, `${path}.title`);
173 validateLocalized(release.summary, `${path}.summary`);
174 invariant(Array.isArray(release.surfaces) && release.surfaces.length > 0, `${path}.surfaces must not be empty`);
175 invariant(new Set(release.surfaces).size === release.surfaces.length, `${path}.surfaces contains duplicates`);
176 invariant(Array.isArray(release.guides), `${path}.guides must be an array`);
177 release.guides.forEach((item, itemIndex) => validateItem(item, `${path}.guides[${itemIndex}]`, { href: true }));
178 invariant(Array.isArray(release.highlights) && release.highlights.length > 0, `${path}.highlights must not be empty`);
179 release.highlights.forEach((item, itemIndex) =>
180 validateItem(item, `${path}.highlights[${itemIndex}]`, { kind: true, targets: targetsRequired }),
181 );
182 invariant(isObject(release.changes), `${path}.changes must be an object`);
183 for (const changeKind of changeKinds) {
184 invariant(Array.isArray(release.changes[changeKind]), `${path}.changes.${changeKind} must be an array`);
185 release.changes[changeKind].forEach((item, itemIndex) =>
186 validateItem(item, `${path}.changes.${changeKind}[${itemIndex}]`, { targets: targetsRequired }),
187 );
188 }
189 invariant(Array.isArray(release.upgrade), `${path}.upgrade must be an array`);
190 release.upgrade.forEach((item, itemIndex) =>
191 validateItem(item, `${path}.upgrade[${itemIndex}]`, { level: true, targets: targetsRequired }),
192 );
193 invariant(Array.isArray(release.risks), `${path}.risks must be an array`);
194 release.risks.forEach((item, itemIndex) =>
195 validateItem(item, `${path}.risks[${itemIndex}]`, { targets: targetsRequired }),
196 );
197 if (targetsRequired) {
198 const derivedTargets = itemTargetsUnion(release);
199 invariant(
200 derivedTargets.includes("desktop") || derivedTargets.includes("cli"),
201 `${path} must contain at least one Desktop or CLI update`,
202 );
203 invariant(
204 derivedTargets.length === release.surfaces.length &&
205 derivedTargets.every((target, index) => target === release.surfaces[index]),
206 `${path}.surfaces must equal the canonical union of item targets`,
207 );
208 }
209 invariant(Array.isArray(release.contributors), `${path}.contributors must be an array`);
210 invariant(isObject(release.links), `${path}.links must be an object`);
211 for (const link of ["github", "compare", "download"]) {
212 invariant(typeof release.links[link] === "string" && /^https:\/\//.test(release.links[link]), `${path}.links.${link} must be HTTPS`);
213 }
214 }
215
216 const sorted = [...catalog.releases].sort((a, b) => compareVersionsDesc(a.version, b.version));
217 invariant(
218 sorted.every((release, index) => release.version === catalog.releases[index].version),
219 "catalog.releases must be sorted newest first",
220 );
221 return catalog;
222 }
223
224 export async function loadCatalog(path = defaultCatalogPath) {
225 const catalog = JSON.parse(await readFile(path, "utf8"));
226 return validateCatalog(catalog);
227 }
228
229 export function releaseForVersion(catalog, version) {
230 const normalized = String(version).replace(/^(?:desktop-|npm-)?v/, "");
231 const release = catalog.releases.find((entry) => entry.version === normalized);
232 invariant(release, `release notes for v${normalized} are missing`);
233 return release;
234 }
235
236 function localized(value, lang) {
237 return value[lang] || value.en;
238 }
239
240 function refsSuffix(refs = []) {
241 if (!refs.length) return "";
242 return ` (${refs.map((ref) => `[#${ref}](https://github.com/esengine/DeepSeek-Reasonix/pull/${ref})`).join(", ")})`;
243 }
244
245 function targetLabel(target) {
246 return { desktop: "Desktop", cli: "CLI", site: "Site", service: "Service" }[target] || target;
247 }
248
249 function targetsPrefix(item) {
250 if (!item.targets?.length) return "";
251 return `**[${item.targets.map(targetLabel).join(" · ")}]** `;
252 }
253
254 function renderItems(items, lang) {
255 return items
256 .map((item) => `- ${targetsPrefix(item)}**${localized(item.title, lang)}** — ${localized(item.body, lang)}${refsSuffix(item.refs)}`)
257 .join("\n");
258 }
259
260 function hasTarget(item, target) {
261 return item.targets?.includes(target) || false;
262 }
263
264 function targetItemCount(release, target) {
265 return releaseItems(release).filter((item) => hasTarget(item, target)).length;
266 }
267
268 function appendTargetSection(lines, release, target, lang) {
269 const isZh = lang === "zh";
270 const title = target === "desktop"
271 ? (isZh ? "桌面端更新" : "Desktop updates")
272 : (isZh ? "CLI 端更新" : "CLI updates");
273 lines.push(`## ${title}`, "");
274
275 const highlights = release.highlights.filter((item) => hasTarget(item, target));
276 if (highlights.length) {
277 lines.push(`### ${isZh ? "重点内容" : "Highlights"}`, "", renderItems(highlights, lang), "");
278 }
279 const headings = {
280 new: isZh ? "新增" : "New",
281 improved: isZh ? "改进" : "Improved",
282 fixed: isZh ? "修复" : "Fixed",
283 };
284 for (const kind of changeKinds) {
285 const items = release.changes[kind].filter((item) => hasTarget(item, target));
286 if (items.length) lines.push(`### ${headings[kind]}`, "", renderItems(items, lang), "");
287 }
288
289 if (!highlights.length && !changeKinds.some((kind) => release.changes[kind].some((item) => hasTarget(item, target)))) {
290 const noTargetedItems = targetItemCount(release, target) === 0;
291 lines.push(
292 target === "cli" && noTargetedItems
293 ? (isZh ? "本版本没有 CLI 相关功能、改进或修复,CLI 用户可按需跳过。" : "This release has no CLI features, improvements, or fixes; CLI users may skip it if preferred.")
294 : (isZh ? "此板块没有功能或修复条目;相关说明请查看下方升级提醒和风险提示。" : "No feature or fix entries are listed here; see the upgrade and risk notes below."),
295 "",
296 );
297 }
298 }
299
300 function appendOtherTargetSection(lines, release, lang) {
301 const isZh = lang === "zh";
302 const isOtherOnly = (item) => item.targets?.length && !hasTarget(item, "desktop") && !hasTarget(item, "cli");
303 const highlights = release.highlights.filter(isOtherOnly);
304 const changes = Object.fromEntries(changeKinds.map((kind) => [kind, release.changes[kind].filter(isOtherOnly)]));
305 if (!highlights.length && !changeKinds.some((kind) => changes[kind].length)) return;
306
307 lines.push(`## ${isZh ? "其他项目更新" : "Other project updates"}`, "");
308 if (highlights.length) lines.push(renderItems(highlights, lang), "");
309 for (const kind of changeKinds) {
310 if (changes[kind].length) lines.push(renderItems(changes[kind], lang), "");
311 }
312 }
313
314 export function renderGitHubRelease(release, lang = "zh") {
315 const isZh = lang === "zh";
316 const isPreview = release.channel === "prerelease";
317 const channelLabel = isPreview ? (isZh ? "预览版" : "Preview") : (isZh ? "稳定版" : "Stable");
318 const lines = [
319 `> ${localized(release.summary, lang)}`,
320 "",
321 `**${isZh ? "发布渠道" : "Release channel"}:${channelLabel} · v${release.version}**`,
322 "",
323 isZh
324 ? `[English →](https://reasonix.io/changelog/v${release.version}/?lang=en) · [网页版完整更新日志 →](https://reasonix.io/changelog/v${release.version}/)`
325 : `[中文 →](https://reasonix.io/changelog/v${release.version}/?lang=zh) · [Full release notes →](https://reasonix.io/changelog/v${release.version}/?lang=en)`,
326 "",
327 ];
328
329 if (release.guides.length) {
330 lines.push(`## ${isZh ? "使用攻略" : "Guides"}`, "");
331 for (const guide of release.guides) {
332 lines.push(`- [**${localized(guide.title, lang)}**](${guide.href}) — ${localized(guide.body, lang)}`);
333 }
334 lines.push("");
335 }
336
337 lines.push(
338 `## ${isZh ? "概览" : "Overview"}`,
339 "",
340 `**Reasonix v${release.version} — ${localized(release.title, lang)}**`,
341 "",
342 localized(release.summary, lang),
343 "",
344 `${isZh ? "发布日期" : "Released"}:${release.date}`,
345 "",
346 );
347
348 if (release.targetingVersion === 1) {
349 lines.push(
350 `**Desktop ${targetItemCount(release, "desktop")} · CLI ${targetItemCount(release, "cli")}**`,
351 "",
352 );
353 appendTargetSection(lines, release, "desktop", lang);
354 appendTargetSection(lines, release, "cli", lang);
355 appendOtherTargetSection(lines, release, lang);
356 } else {
357 lines.push(`## ${isZh ? "重点内容" : "Highlights"}`, "", renderItems(release.highlights, lang), "");
358 const headings = {
359 new: isZh ? "新功能" : "New",
360 improved: isZh ? "改进" : "Improved",
361 fixed: isZh ? "修复" : "Fixed",
362 };
363 for (const kind of changeKinds) {
364 const items = release.changes[kind];
365 if (!items.length) continue;
366 lines.push(`## ${headings[kind]}`, "", renderItems(items, lang), "");
367 }
368 }
369
370 lines.push(`## ${isZh ? "升级提醒" : "Upgrade notes"}`, "");
371 if (release.upgrade.length) lines.push(renderItems(release.upgrade, lang));
372 else lines.push(isZh ? "本版本无需手动迁移。" : "No manual migration is required.");
373 lines.push("");
374
375 lines.push(`## ${isZh ? "风险提示" : "Risk notes"}`, "");
376 if (release.risks.length) lines.push(renderItems(release.risks, lang));
377 else lines.push(isZh ? "当前没有需要额外操作的已知风险。" : "There are no known risks requiring extra action.");
378 lines.push("");
379
380 if (release.contributors.length) {
381 lines.push(
382 `## ${isZh ? "致谢" : "Thanks"}`,
383 "",
384 `${isZh ? "感谢本版本的贡献者" : "Thanks to the contributors in this release"}:${release.contributors
385 .map((name) => `[@${name}](https://github.com/${name})`)
386 .join("、")}`,
387 "",
388 );
389 }
390
391 lines.push(
392 `## ${isZh ? "下载与安装" : "Download and install"}`,
393 "",
394 `- [${isZh ? "官网按平台下载" : "Platform downloads"}](${release.links.download})`,
395 `- [${isZh ? "查看完整差异" : "Full comparison"}](${release.links.compare})`,
396 "",
397 );
398 return `${lines.join("\n").trim()}\n`;
399 }
400
401 export async function upsertRelease(release, path = defaultCatalogPath) {
402 const catalog = await loadCatalog(path);
403 const next = {
404 ...catalog,
405 releases: [release, ...catalog.releases.filter((entry) => entry.version !== release.version)].sort((a, b) =>
406 compareVersionsDesc(a.version, b.version),
407 ),
408 };
409 validateCatalog(next);
410 await writeFile(path, `${JSON.stringify(next, null, 2)}\n`);
411 return next;
412 }
413
414 function parseArgs(argv) {
415 const [command = "validate", ...rest] = argv;
416 const values = { command };
417 for (let i = 0; i < rest.length; i += 1) {
418 const arg = rest[i];
419 if (!arg.startsWith("--")) throw new Error(`unexpected argument ${arg}`);
420 values[arg.slice(2)] = rest[++i];
421 }
422 return values;
423 }
424
425 async function main() {
426 const args = parseArgs(process.argv.slice(2));
427 const catalogPath = args.catalog ? resolve(args.catalog) : defaultCatalogPath;
428 const catalog = await loadCatalog(catalogPath);
429 if (args.command === "validate") {
430 console.log(`Validated ${catalog.releases.length} release note(s).`);
431 return;
432 }
433 if (args.command !== "render") throw new Error(`unknown command ${args.command}`);
434 invariant(args.version, "render requires --version");
435 invariant(args.output, "render requires --output");
436 const release = releaseForVersion(catalog, args.version);
437 const output = resolve(args.output);
438 await writeFile(output, renderGitHubRelease(release, args.lang === "en" ? "en" : "zh"));
439 console.log(`Rendered v${release.version} release notes to ${output}`);
440 }
441
442 if (process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
443 main().catch((error) => {
444 console.error(error.message);
445 process.exitCode = 1;
446 });
447 }
448
448 lines Plain Text