mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2026-07-14 16:45:59 +00:00
Automate and validate the release flow (#998)
* improve release flow * limit permission * Test and harden the release workflow * Keep workspace lockfile versions aligned * Run release regression tests in CI
This commit is contained in:
vorotamoroz
@@ -0,0 +1,147 @@
|
||||
import { readFileSync, writeFileSync } from "fs";
|
||||
|
||||
const updatesPath = "updates.md";
|
||||
|
||||
// Utility used by the release workflows to rotate and validate `updates.md`.
|
||||
// It intentionally keeps the Markdown format simple: top-level `##` headings
|
||||
// are treated as release boundaries, and only one `## Unreleased` section is
|
||||
// allowed.
|
||||
|
||||
function fail(message) {
|
||||
console.error(message);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
function readJson(path) {
|
||||
return JSON.parse(readFileSync(path, "utf8"));
|
||||
}
|
||||
|
||||
function assertVersion(version) {
|
||||
if (!/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(version)) {
|
||||
fail(`Invalid release version: ${version}`);
|
||||
}
|
||||
}
|
||||
|
||||
function formatReleaseDate(date = new Date()) {
|
||||
const day = date.getUTCDate();
|
||||
const suffix =
|
||||
day % 10 === 1 && day !== 11
|
||||
? "st"
|
||||
: day % 10 === 2 && day !== 12
|
||||
? "nd"
|
||||
: day % 10 === 3 && day !== 13
|
||||
? "rd"
|
||||
: "th";
|
||||
const month = new Intl.DateTimeFormat("en-GB", { month: "long", timeZone: "UTC" }).format(date);
|
||||
const year = date.getUTCFullYear();
|
||||
return `${day}${suffix} ${month}, ${year}`;
|
||||
}
|
||||
|
||||
function headingPattern(heading) {
|
||||
return new RegExp(`^## ${heading.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\s*$`, "m");
|
||||
}
|
||||
|
||||
// Return a `##` section body without interpreting lower-level headings.
|
||||
function findSection(markdown, heading) {
|
||||
const pattern = headingPattern(heading);
|
||||
const match = pattern.exec(markdown);
|
||||
if (!match) return undefined;
|
||||
|
||||
const headingStart = match.index;
|
||||
const bodyStart = match.index + match[0].length;
|
||||
const rest = markdown.slice(bodyStart);
|
||||
const next = /^## .+$/m.exec(rest);
|
||||
const end = next ? bodyStart + next.index : markdown.length;
|
||||
|
||||
return {
|
||||
headingStart,
|
||||
bodyStart,
|
||||
end,
|
||||
body: markdown.slice(bodyStart, end),
|
||||
};
|
||||
}
|
||||
|
||||
function assertSingleUnreleased(markdown) {
|
||||
const matches = markdown.match(/^## Unreleased\s*$/gm) || [];
|
||||
if (matches.length !== 1) {
|
||||
fail(`Expected exactly one '## Unreleased' section in ${updatesPath}, found ${matches.length}.`);
|
||||
}
|
||||
}
|
||||
|
||||
function prepare(version) {
|
||||
assertVersion(version);
|
||||
const markdown = readFileSync(updatesPath, "utf8");
|
||||
assertSingleUnreleased(markdown);
|
||||
|
||||
if (headingPattern(version).test(markdown)) {
|
||||
fail(`Release notes for ${version} already exist in ${updatesPath}.`);
|
||||
}
|
||||
|
||||
const unreleased = findSection(markdown, "Unreleased");
|
||||
if (!unreleased) fail(`Could not find '## Unreleased' in ${updatesPath}.`);
|
||||
|
||||
const allowEmpty = process.env.ALLOW_EMPTY_UPDATES === "true";
|
||||
if (!allowEmpty && unreleased.body.trim() === "") {
|
||||
fail(`The '## Unreleased' section is empty. Set ALLOW_EMPTY_UPDATES=true if this is intentional.`);
|
||||
}
|
||||
|
||||
// Keep a fresh empty Unreleased section above the newly dated release notes.
|
||||
const releasedBody = `${unreleased.body.trim()}\n\n`;
|
||||
const releaseDate = process.env.RELEASE_DATE || formatReleaseDate();
|
||||
const replacement = `## Unreleased\n\n## ${version}\n\n${releaseDate}\n\n${releasedBody}`;
|
||||
const nextMarkdown = markdown.slice(0, unreleased.headingStart) + replacement + markdown.slice(unreleased.end);
|
||||
writeFileSync(updatesPath, nextMarkdown, "utf8");
|
||||
}
|
||||
|
||||
function validate(version) {
|
||||
assertVersion(version);
|
||||
|
||||
const rootPackage = readJson("package.json");
|
||||
const manifest = readJson("manifest.json");
|
||||
if (rootPackage.version !== version) {
|
||||
fail(`package.json version is ${rootPackage.version}, expected ${version}.`);
|
||||
}
|
||||
if (manifest.version !== version) {
|
||||
fail(`manifest.json version is ${manifest.version}, expected ${version}.`);
|
||||
}
|
||||
|
||||
for (const workspace of ["cli", "webpeer", "webapp"]) {
|
||||
const workspacePackage = readJson(`src/apps/${workspace}/package.json`);
|
||||
const expected = `${version}-${workspace}`;
|
||||
if (workspacePackage.version !== expected) {
|
||||
fail(`src/apps/${workspace}/package.json version is ${workspacePackage.version}, expected ${expected}.`);
|
||||
}
|
||||
}
|
||||
|
||||
const versions = readJson("versions.json");
|
||||
if (versions[version] !== manifest.minAppVersion) {
|
||||
fail(`versions.json does not map ${version} to manifest minAppVersion ${manifest.minAppVersion}.`);
|
||||
}
|
||||
|
||||
const markdown = readFileSync(updatesPath, "utf8");
|
||||
assertSingleUnreleased(markdown);
|
||||
|
||||
const releaseSection = findSection(markdown, version);
|
||||
if (!releaseSection) {
|
||||
fail(`Could not find '## ${version}' in ${updatesPath}.`);
|
||||
}
|
||||
if (releaseSection.body.trim() === "") {
|
||||
fail(`The release notes for ${version} are empty.`);
|
||||
}
|
||||
if (/\b(?:TODO|WIP)\b/i.test(releaseSection.body)) {
|
||||
fail(`The release notes for ${version} still contain TODO or WIP markers.`);
|
||||
}
|
||||
}
|
||||
|
||||
const [command, version] = process.argv.slice(2);
|
||||
if (!command || !version) {
|
||||
fail("Usage: node utils/release-notes.mjs <prepare|validate> <version>");
|
||||
}
|
||||
|
||||
if (command === "prepare") {
|
||||
prepare(version);
|
||||
} else if (command === "validate") {
|
||||
validate(version);
|
||||
} else {
|
||||
fail(`Unknown command: ${command}`);
|
||||
}
|
||||
@@ -0,0 +1,160 @@
|
||||
import { afterEach, describe, expect, it } from "vitest";
|
||||
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { dirname, join } from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const releaseNotesScript = fileURLToPath(new URL("./release-notes.mjs", import.meta.url));
|
||||
const versionBumpScript =
|
||||
process.env.VERSION_BUMP_SCRIPT || fileURLToPath(new URL("../version-bump.mjs", import.meta.url));
|
||||
const workspaceUpdateScript = fileURLToPath(new URL("../update-workspaces.mjs", import.meta.url));
|
||||
const temporaryDirectories: string[] = [];
|
||||
|
||||
afterEach(() => {
|
||||
for (const directory of temporaryDirectories.splice(0)) {
|
||||
rmSync(directory, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
function makeTemporaryDirectory(): string {
|
||||
const directory = mkdtempSync(join(tmpdir(), "livesync-release-notes-"));
|
||||
temporaryDirectories.push(directory);
|
||||
return directory;
|
||||
}
|
||||
|
||||
function writeJson(directory: string, path: string, value: unknown): void {
|
||||
const fullPath = join(directory, path);
|
||||
mkdirSync(dirname(fullPath), { recursive: true });
|
||||
writeFileSync(fullPath, `${JSON.stringify(value, null, 4)}\n`, "utf8");
|
||||
}
|
||||
|
||||
function runNode(script: string, args: string[], cwd: string, env: Record<string, string> = {}) {
|
||||
return spawnSync(process.execPath, [script, ...args], {
|
||||
cwd,
|
||||
encoding: "utf8",
|
||||
env: { ...process.env, ...env },
|
||||
});
|
||||
}
|
||||
|
||||
function createReleaseFixture(version = "0.25.81"): string {
|
||||
const directory = makeTemporaryDirectory();
|
||||
writeJson(directory, "package.json", { version });
|
||||
writeJson(directory, "manifest.json", { version, minAppVersion: "1.7.2" });
|
||||
writeJson(directory, "versions.json", { [version]: "1.7.2" });
|
||||
for (const workspace of ["cli", "webpeer", "webapp"]) {
|
||||
writeJson(directory, `src/apps/${workspace}/package.json`, { version: `${version}-${workspace}` });
|
||||
}
|
||||
writeFileSync(
|
||||
join(directory, "updates.md"),
|
||||
"# 0.25\n\n## Unreleased\n\n### Fixed\n\n- Preserved file content.\n\n## 0.25.80\n\n7th July, 2026\n\n- Previous release.\n",
|
||||
"utf8"
|
||||
);
|
||||
return directory;
|
||||
}
|
||||
|
||||
describe("release notes", () => {
|
||||
it("moves Unreleased notes into a dated release and validates the result", () => {
|
||||
const directory = createReleaseFixture();
|
||||
|
||||
const prepared = runNode(releaseNotesScript, ["prepare", "0.25.81"], directory, {
|
||||
RELEASE_DATE: "14th July, 2026",
|
||||
});
|
||||
|
||||
expect(prepared.status, prepared.stderr).toBe(0);
|
||||
expect(readFileSync(join(directory, "updates.md"), "utf8")).toBe(
|
||||
"# 0.25\n\n## Unreleased\n\n## 0.25.81\n\n14th July, 2026\n\n### Fixed\n\n- Preserved file content.\n\n## 0.25.80\n\n7th July, 2026\n\n- Previous release.\n"
|
||||
);
|
||||
|
||||
const validated = runNode(releaseNotesScript, ["validate", "0.25.81"], directory);
|
||||
expect(validated.status, validated.stderr).toBe(0);
|
||||
});
|
||||
|
||||
it("rejects an empty Unreleased section unless explicitly allowed", () => {
|
||||
const directory = createReleaseFixture();
|
||||
writeFileSync(
|
||||
join(directory, "updates.md"),
|
||||
"# 0.25\n\n## Unreleased\n\n## 0.25.80\n\nPrevious release.\n",
|
||||
"utf8"
|
||||
);
|
||||
|
||||
const rejected = runNode(releaseNotesScript, ["prepare", "0.25.81"], directory);
|
||||
expect(rejected.status).toBe(1);
|
||||
expect(rejected.stderr).toContain("The '## Unreleased' section is empty.");
|
||||
|
||||
const allowed = runNode(releaseNotesScript, ["prepare", "0.25.81"], directory, {
|
||||
ALLOW_EMPTY_UPDATES: "true",
|
||||
RELEASE_DATE: "14th July, 2026",
|
||||
});
|
||||
expect(allowed.status, allowed.stderr).toBe(0);
|
||||
});
|
||||
|
||||
it("rejects unfinished release notes", () => {
|
||||
const directory = createReleaseFixture();
|
||||
writeFileSync(
|
||||
join(directory, "updates.md"),
|
||||
"# 0.25\n\n## Unreleased\n\n## 0.25.81\n\n14th July, 2026\n\n- TODO: finish these notes.\n",
|
||||
"utf8"
|
||||
);
|
||||
|
||||
const result = runNode(releaseNotesScript, ["validate", "0.25.81"], directory);
|
||||
expect(result.status).toBe(1);
|
||||
expect(result.stderr).toContain("still contain TODO or WIP markers");
|
||||
});
|
||||
});
|
||||
|
||||
describe("version bump", () => {
|
||||
it("records every release even when its minimum app version is already used", () => {
|
||||
const directory = makeTemporaryDirectory();
|
||||
writeJson(directory, "manifest.json", { version: "0.25.80", minAppVersion: "1.7.2" });
|
||||
writeJson(directory, "versions.json", { "0.25.61": "1.7.2" });
|
||||
|
||||
const result = runNode(versionBumpScript, [], directory, { npm_package_version: "0.25.81" });
|
||||
|
||||
expect(result.status, result.stderr).toBe(0);
|
||||
expect(JSON.parse(readFileSync(join(directory, "manifest.json"), "utf8"))).toMatchObject({
|
||||
version: "0.25.81",
|
||||
minAppVersion: "1.7.2",
|
||||
});
|
||||
expect(JSON.parse(readFileSync(join(directory, "versions.json"), "utf8"))).toEqual({
|
||||
"0.25.61": "1.7.2",
|
||||
"0.25.81": "1.7.2",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("workspace version update", () => {
|
||||
it("keeps workspace package and lockfile versions together", () => {
|
||||
const directory = makeTemporaryDirectory();
|
||||
const workspaces = ["src/apps/cli", "src/apps/webpeer", "src/apps/webapp"];
|
||||
writeJson(directory, "package.json", { version: "0.25.81", workspaces });
|
||||
for (const workspace of ["cli", "webpeer", "webapp"]) {
|
||||
writeJson(directory, `src/apps/${workspace}/package.json`, { version: `0.25.80-${workspace}` });
|
||||
}
|
||||
writeJson(directory, "package-lock.json", {
|
||||
name: "obsidian-livesync",
|
||||
version: "0.25.80",
|
||||
lockfileVersion: 3,
|
||||
packages: {
|
||||
"": { version: "0.25.80", workspaces },
|
||||
"src/apps/cli": { version: "0.25.80-cli" },
|
||||
"src/apps/webpeer": { version: "0.25.80-webpeer" },
|
||||
"src/apps/webapp": { version: "0.25.80-webapp" },
|
||||
},
|
||||
});
|
||||
|
||||
const result = runNode(workspaceUpdateScript, [], directory);
|
||||
|
||||
expect(result.status, result.stderr).toBe(0);
|
||||
for (const workspace of ["cli", "webpeer", "webapp"]) {
|
||||
const packageJson = JSON.parse(readFileSync(join(directory, `src/apps/${workspace}/package.json`), "utf8"));
|
||||
expect(packageJson.version).toBe(`0.25.81-${workspace}`);
|
||||
}
|
||||
const packageLock = JSON.parse(readFileSync(join(directory, "package-lock.json"), "utf8"));
|
||||
expect(packageLock.version).toBe("0.25.81");
|
||||
expect(packageLock.packages[""].version).toBe("0.25.81");
|
||||
expect(packageLock.packages["src/apps/cli"].version).toBe("0.25.81-cli");
|
||||
expect(packageLock.packages["src/apps/webpeer"].version).toBe("0.25.81-webpeer");
|
||||
expect(packageLock.packages["src/apps/webapp"].version).toBe("0.25.81-webapp");
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user