fix(ci): validate generated size history branches

Author: chh-ay

.changeset/size-history-ci-policy.md

@@ -0,0 +1,2 @@
+---
+---

scripts/changeset-ci.ts

@@ -4,10 +4,52 @@ import { PUBLISHABLE_PACKAGE_ORDER } from "./workspace-tooling.js";
 
 const STABLE_VERSION = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/;
 const REPOSITORY_ROOT = resolve(import.meta.dir, "..");
+const PACKAGE_SIZE_HISTORY_PREFIX = "automation/package-size-history-";
+const REQUIRED_PACKAGE_SIZE_HISTORY_FILES = new Set([
+  "docs/src/content/docs/guides/performance-resources.md",
+  "scripts/size-history.json",
+]);
+const ALLOWED_PACKAGE_SIZE_HISTORY_FILES = new Set([
+  ...REQUIRED_PACKAGE_SIZE_HISTORY_FILES,
+  "docs/src/generated/docs-contract.json",
+]);
 
 export function releaseVersionFromHeadRef(headRef: string | undefined): string | undefined {
   return headRef !== undefined && STABLE_VERSION.test(headRef) ? headRef : undefined;
 }
+export function packageSizeHistoryVersionFromHeadRef(
+  headRef: string | undefined,
+): string | undefined {
+  if (headRef === undefined || !headRef.startsWith(PACKAGE_SIZE_HISTORY_PREFIX)) return undefined;
+  const version = headRef.slice(PACKAGE_SIZE_HISTORY_PREFIX.length);
+  return STABLE_VERSION.test(version) ? version : undefined;
+}
+export function isGeneratedPackageSizeHistoryChange(paths: readonly string[]): boolean {
+  const uniquePaths = new Set(paths);
+  return (
+    uniquePaths.size === paths.length &&
+    [...REQUIRED_PACKAGE_SIZE_HISTORY_FILES].every((path) => uniquePaths.has(path)) &&
+    paths.every((path) => ALLOWED_PACKAGE_SIZE_HISTORY_FILES.has(path))
+  );
+}
+
+async function changedFilesSinceDevelop(): Promise<string[]> {
+  const child = Bun.spawn(["git", "diff", "--name-only", "origin/develop...HEAD"], {
+    cwd: REPOSITORY_ROOT,
+    stdout: "pipe",
+    stderr: "pipe",
+  });
+  const [stdout, stderr, exitCode] = await Promise.all([
+    new Response(child.stdout).text(),
+    new Response(child.stderr).text(),
+    child.exited,
+  ]);
+  if (exitCode !== 0) throw new Error(`Unable to inspect package size history diff: ${stderr}`);
+  return stdout
+    .split("\n")
+    .map((path) => path.trim())
+    .filter((path) => path.length > 0);
+}
 
 export function validateReleasePackageVersions(version: string, root = REPOSITORY_ROOT): void {
   for (const name of PUBLISHABLE_PACKAGE_ORDER) {
@@ -30,6 +72,19 @@ async function main(): Promise<void> {
     console.log(`Release package versions match branch ${releaseVersion}`);
     return;
   }
+  const packageSizeHistoryVersion = packageSizeHistoryVersionFromHeadRef(
+    process.env.GITHUB_HEAD_REF,
+  );
+  if (packageSizeHistoryVersion !== undefined) {
+    validateReleasePackageVersions(packageSizeHistoryVersion);
+    if (isGeneratedPackageSizeHistoryChange(await changedFilesSinceDevelop())) {
+      console.log(`Package size history versions match branch ${packageSizeHistoryVersion}`);
+      return;
+    }
+    console.log(
+      "Package size history branch contains non-generated changes; requiring a changeset",
+    );
+  }
   const child = Bun.spawn(["bun", "run", "changeset:status", "--", "--since=origin/develop"], {
     cwd: REPOSITORY_ROOT,
     stdin: "inherit",

scripts/workspace-tooling.test.ts

@@ -2,7 +2,12 @@ import { afterEach, describe, expect, it } from "bun:test";
 import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { join, resolve } from "node:path";
-import { releaseVersionFromHeadRef, validateReleasePackageVersions } from "./changeset-ci.js";
+import {
+  isGeneratedPackageSizeHistoryChange,
+  packageSizeHistoryVersionFromHeadRef,
+  releaseVersionFromHeadRef,
+  validateReleasePackageVersions,
+} from "./changeset-ci.js";
 import {
   assertUniqueOrderedNodes,
   PACKAGE_BUILD_NODES,
@@ -246,6 +251,40 @@ describe("changeset workspace contract", () => {
   it("runs the release-aware Changesets status command", () => {
     expect(releaseVersionFromHeadRef("0.3.1")).toBe("0.3.1");
     expect(releaseVersionFromHeadRef("feature/docs")).toBeUndefined();
+    expect(packageSizeHistoryVersionFromHeadRef("automation/package-size-history-0.3.1")).toBe(
+      "0.3.1",
+    );
+    expect(packageSizeHistoryVersionFromHeadRef("automation/package-size-history-next")).toBe(
+      undefined,
+    );
+    expect(
+      isGeneratedPackageSizeHistoryChange([
+        "docs/src/content/docs/guides/performance-resources.md",
+        "scripts/size-history.json",
+      ]),
+    ).toBeTrue();
+    expect(
+      isGeneratedPackageSizeHistoryChange([
+        "docs/src/content/docs/guides/performance-resources.md",
+        "docs/src/generated/docs-contract.json",
+        "scripts/size-history.json",
+      ]),
+    ).toBeTrue();
+    expect(
+      isGeneratedPackageSizeHistoryChange([
+        "docs/src/content/docs/guides/performance-resources.md",
+        "scripts/changeset-ci.ts",
+        "scripts/size-history.json",
+      ]),
+    ).toBeFalse();
+    expect(isGeneratedPackageSizeHistoryChange(["scripts/size-history.json"])).toBeFalse();
+    expect(
+      isGeneratedPackageSizeHistoryChange([
+        "docs/src/content/docs/guides/performance-resources.md",
+        "scripts/size-history.json",
+        "scripts/size-history.json",
+      ]),
+    ).toBeFalse();
     expect(() => validateReleasePackageVersions("0.3.1")).not.toThrow();
     expect(() => validateReleasePackageVersions("0.3.2")).toThrow(
       "Release branch 0.3.2 requires @sheetwrite/wasm@0.3.2",