Files
Piik/scripts/release-notes.mjs
T
AAA 4ff970f483 fix(website): simplify downloads and scope product releases (#390)
## Problem and outcome

Website visitors can download the usual Windows x64, macOS Apple silicon
and Linux x64 App packages directly from clearly labeled platform cards.
Each card includes a verified Gitee alternative, with shared setup
guidance and a More downloads link for the full release list. The
homepage reuses the application's 20 bilingual greetings, and the sample
game no longer displays an invented title.

Website builds resolve links from the latest published GitHub release
and validate matching mirror assets. Website deployment follows main CI
so newly published packages reach the next site build. Version selection
and release notes now share a product-change filter: standalone website,
documentation and maintenance changes do not create App/Server releases
or affect the next product version.

## Verification

- `npm run check`: 57 test files / 759 tests, TypeScript and product
production build passed.
- Website build passed with real GitHub/Gitee v1.0.0 metadata and with
the explicit local fallback.
- English and Chinese browser checks at 390px and 1440px passed:
platform links, More downloads, greeting selection and language
switching.
- All 23 website film check groups passed; the final shared artwork
change rebuilt successfully.
- Documentation, repository hygiene and diff checks passed. Real
Git-history tests cover product/website mixtures and moves across the
release boundary; the accepted phase plans `publish: false`.

## Impact

GitHub remains the version authority; Gitee is a download mirror.
Unavailable mirror metadata falls back to its release page. Product
runtime behavior and package compatibility are unchanged. Physical
macOS/Linux capture and broader device/network limits remain documented.
2026-09-12 23:01:48 +08:00

52 lines
2.6 KiB
JavaScript

import { appendFileSync } from "node:fs";
import { pathToFileURL } from "node:url";
import semver from "semver";
import { isReleaseVersion, releaseCommits, stableTags } from "./release-version.mjs";
// The reviewed PR body survives the squash commit. Only its public section is
// release copy; implementation details and verification logs stay in the PR.
export function releaseNotes(root, version, revision, repository, { allowEmpty = false } = {}) {
if (!isReleaseVersion(version) || !/^[a-f0-9]{40}$/.test(revision) ||
!/^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$/.test(repository)) {
throw new Error("Release notes require a stable version, full SHA and owner/repository");
}
// Exclude this release's tag so retrying after publication keeps the same range.
const previous = stableTags(root, "--merged", revision).find((tag) => semver.lt(tag, version));
const bodies = [];
for (const commit of releaseCommits(root, revision, previous)) {
const sections = commit.message.replace(/\r\n/g, "\n").split(/^## /m).slice(1)
.filter((section) => section.split("\n", 1)[0].trim() === "Release notes");
const body = sections.length === 1
? sections[0].split("\n").slice(1).join("\n").replace(/<!--[\s\S]*?-->/g, "").trim()
: "";
if (!body || !body.split("\n").some((line) => line.trim() && !/^#{1,6}(\s|$)/.test(line))) {
throw new Error(`Commit ${commit.revision} needs one nonempty ## Release notes section`);
}
bodies.push(body);
}
if (!bodies.length) {
if (allowEmpty) return "";
throw new Error("No release changes found");
}
const url = `https://github.com/${repository}`;
const source = previous
? `[完整变更 / Full changelog](${url}/compare/${previous}...${revision})`
: `[源代码 / Source](${url}/tree/${revision})`;
return `${bodies.join("\n\n")}\n\n---\n\n${source}\n`;
}
if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
const [version, revision, option] = process.argv.slice(2);
if (option && option !== "--github-summary") {
throw new Error("Use release-notes.mjs <version> <full-SHA> [--github-summary]");
}
const body = releaseNotes(process.cwd(), version, revision,
process.env.GITHUB_REPOSITORY || "TNTcraftHIM/Piik", { allowEmpty: Boolean(option) });
if (option) {
if (!process.env.GITHUB_STEP_SUMMARY) throw new Error("GITHUB_STEP_SUMMARY is missing");
appendFileSync(process.env.GITHUB_STEP_SUMMARY,
`## Release notes preview: Piik ${version}\n\n${body || "No product changes; this candidate does not publish a release.\n"}`);
}
process.stdout.write(body);
}