Florian Wilde
586e1f042f
Bisher liess sich der laufenden Anwendung nicht ansehen, welche Fassung sie ist. Nach einem Update war damit auch nicht zu erkennen, ob es angekommen ist — die haeufigste Frage im Betrieb. Die Fussleiste nennt jetzt die Version und fuehrt auf /version mit dem vollstaendigen Verlauf. Zusammengetragen ist er aus dem, was es schon gab: dem Abschnitt „Gebaut" der Roadmap und der Git-Historie. Gepflegt wird der Verlauf an genau einer Stelle, src/lib/changelog.ts. Daraus entsteht sowohl die Seite als auch die CHANGELOG.md (npm run changelog); eine Pruefung mit --check wacht darueber, dass beides zusammenpasst. Zwei gepflegte Listen liefen unweigerlich auseinander, und ein Changelog, der nicht stimmt, ist schlimmer als keiner. Die Historie hatte keine Tags. Die Eintraege sind deshalb nach Erscheinungstag zu Versionen zusammengefasst — die Nummern sind nachtraeglich vergeben, die Daten stammen aus den Commits. Zu jeder Version gibt es jetzt einen annotierten Tag im Repo; v1.6.0 folgt beim Merge. Die Roadmap fuehrt den Verlauf nicht mehr doppelt, sondern verweist darauf und behaelt den Blick nach vorn. Refs #9
85 lines
2.7 KiB
JavaScript
85 lines
2.7 KiB
JavaScript
/**
|
|
* Schreibt CHANGELOG.md aus src/lib/changelog.ts.
|
|
*
|
|
* node scripts/changelog.mjs erzeugen
|
|
* node scripts/changelog.mjs --check nur prüfen, ob die Datei aktuell ist
|
|
*
|
|
* Warum erzeugt und nicht von Hand gepflegt: Die Anwendung zeigt denselben
|
|
* Verlauf unter /version an. Zwei gepflegte Listen liefen unweigerlich
|
|
* auseinander — und ein Changelog, der nicht stimmt, ist schlimmer als keiner.
|
|
*/
|
|
import { readFileSync, writeFileSync } from "node:fs";
|
|
import { fileURLToPath } from "node:url";
|
|
import { dirname, join } from "node:path";
|
|
|
|
const wurzel = join(dirname(fileURLToPath(import.meta.url)), "..");
|
|
const ziel = join(wurzel, "CHANGELOG.md");
|
|
|
|
/**
|
|
* Die Quelle ist TypeScript, dieses Skript aber schlichtes Node. Statt einen
|
|
* Übersetzer dazuzunehmen, wird der Datenteil gelesen und ausgewertet — er
|
|
* besteht ausschließlich aus Zeichenketten und Listen.
|
|
*/
|
|
function ladeVerlauf() {
|
|
const quelle = readFileSync(join(wurzel, "src", "lib", "changelog.ts"), "utf8");
|
|
const anfang = quelle.indexOf("export const CHANGELOG");
|
|
if (anfang === -1) throw new Error("CHANGELOG-Liste nicht gefunden.");
|
|
|
|
const start = quelle.indexOf("[", anfang);
|
|
const ende = quelle.indexOf("\n];", start);
|
|
if (start === -1 || ende === -1) throw new Error("Liste nicht abgrenzbar.");
|
|
|
|
const literal = quelle.slice(start, ende + 2);
|
|
return Function(`"use strict"; return (${literal});`)();
|
|
}
|
|
|
|
function formatiereDatum(iso) {
|
|
const [jahr, monat, tag] = iso.split("-");
|
|
return `${tag}.${monat}.${jahr}`;
|
|
}
|
|
|
|
function baue(verlauf) {
|
|
const zeilen = [
|
|
"# Änderungen",
|
|
"",
|
|
"Was in welcher Fassung dazugekommen ist. Dieselbe Liste steht in der",
|
|
"Anwendung unter **Version und Änderungen**, erreichbar über die",
|
|
"Versionsnummer in der Fußzeile.",
|
|
"",
|
|
"> Diese Datei wird erzeugt: `npm run changelog`.",
|
|
"> Gepflegt wird der Verlauf in `src/lib/changelog.ts`.",
|
|
"",
|
|
];
|
|
|
|
for (const eintrag of verlauf) {
|
|
zeilen.push(`## ${eintrag.version} — ${formatiereDatum(eintrag.date)}`, "");
|
|
zeilen.push(eintrag.summary, "");
|
|
for (const änderung of eintrag.changes) zeilen.push(`- ${änderung}`);
|
|
zeilen.push("");
|
|
}
|
|
|
|
return zeilen.join("\n");
|
|
}
|
|
|
|
const inhalt = baue(ladeVerlauf());
|
|
|
|
if (process.argv.includes("--check")) {
|
|
let vorhanden = "";
|
|
try {
|
|
vorhanden = readFileSync(ziel, "utf8");
|
|
} catch {
|
|
console.error("CHANGELOG.md fehlt. Erzeugen mit: npm run changelog");
|
|
process.exit(1);
|
|
}
|
|
if (vorhanden !== inhalt) {
|
|
console.error(
|
|
"CHANGELOG.md passt nicht mehr zu src/lib/changelog.ts. Neu erzeugen mit: npm run changelog",
|
|
);
|
|
process.exit(1);
|
|
}
|
|
console.log("CHANGELOG.md ist aktuell.");
|
|
} else {
|
|
writeFileSync(ziel, inhalt, "utf8");
|
|
console.log("CHANGELOG.md geschrieben.");
|
|
}
|