1 files changed, 129 insertions, 0 deletions
diff --git a/scripts/docs/versions.integration.test.ts b/scripts/docs/versions.integration.test.ts
new file mode 100644
index 00000000..a52be1be
--- /dev/null
+++ b/scripts/docs/versions.integration.test.ts
@@ -0,0 +1,129 @@
+import { afterEach, describe, expect, test } from 'bun:test';
+import { execFileSync } from 'node:child_process';
+import { mkdtemp, mkdir, readFile, rm, symlink, writeFile } from 'node:fs/promises';
+import { join, resolve } from 'node:path';
+import { tmpdir } from 'node:os';
+
+const script = resolve(import.meta.dir, 'versions.mjs');
+const temporaryDirectories: string[] = [];
+
+afterEach(async () => {
+  await Promise.all(
+    temporaryDirectories.splice(0).map((path) => rm(path, { recursive: true, force: true })),
+  );
+});
+
+describe('documentation release publishing', () => {
+  test('publishes immutable tagged snapshots and validates maintained corrections', async () => {
+    const root = await mkdtemp(join(tmpdir(), 'herdr-docs-'));
+    temporaryDirectories.push(root);
+    await write(root, 'distribution/latest.json', '{"version":"0.9.0"}\n');
+    await write(root, 'README.md', 'stable readme\n');
+    await write(root, 'README.zh-CN.md', 'stable readme zh-cn\n');
+    const nextDocs = '---\ntitle: Documentation\n---\n\nnext docs\n';
+    await write(root, 'docs/next/website/src/content/docs/index.mdx', nextDocs);
+    await write(root, 'docs/next/website/src/data/config-reference.json', '{"next":true}\n');
+    await write(root, 'docs/next/README.md', 'next readme\n');
+    await write(root, 'docs/next/README.zh-CN.md', 'next readme zh-cn\n');
+
+    git(root, ['init', '-q']);
+    git(root, ['config', 'user.email', 'test@example.com']);
+    git(root, ['config', 'user.name', 'Test']);
+    git(root, ['add', '.']);
+    git(root, ['commit', '-qm', 'release fixture']);
+    git(root, ['tag', 'v0.9.0']);
+    git(root, ['tag', 'v1.0.0']);
+
+    runScript(root, ['publish', 'v1.0.0']);
+
+    expect(await read(root, 'README.md')).toBe('next readme\n');
+    expect(await read(root, 'README.zh-CN.md')).toBe('next readme zh-cn\n');
+    expect(await read(root, 'docs/versions/1.0.0/website/src/content/docs/index.mdx')).toBe(
+      nextDocs,
+    );
+
+    const manifest = JSON.parse(await read(root, 'docs/versions/manifest.json'));
+    expect(manifest.current).toBe('1.0.0');
+    expect(manifest.stable_source).toBe('snapshot');
+    expect(manifest.versions[0]).toMatchObject({
+      version: '1.0.0',
+      tag: 'v1.0.0',
+      commit: expect.stringMatching(/^[0-9a-f]{40}$/),
+      source: 'docs/next/website/src/content/docs',
+    });
+
+    await write(root, 'distribution/latest.json', '{"version":"1.0.0"}\n');
+    runScript(root, ['check']);
+
+    const correctedDocs = '---\ntitle: Documentation\n---\n\ncorrected docs\n';
+    await write(root, 'docs/versions/1.0.0/website/src/content/docs/index.mdx', correctedDocs);
+    await write(
+      root,
+      'docs/versions/1.0.0/website/src/data/config-reference.json',
+      '{"corrected":true}\n',
+    );
+    runScript(root, ['check']);
+
+    await write(root, 'README.md', 'post-release correction\n');
+    runScript(root, ['publish', 'v1.0.0']);
+    expect(await read(root, 'README.md')).toBe('post-release correction\n');
+
+    runScript(root, ['publish', 'v0.9.0']);
+    const archivedManifest = JSON.parse(await read(root, 'docs/versions/manifest.json'));
+    expect(archivedManifest.current).toBe('1.0.0');
+    expect(archivedManifest.versions.map(({ version }) => version)).toEqual(['1.0.0', '0.9.0']);
+    expect(await read(root, 'README.md')).toBe('post-release correction\n');
+    runScript(root, ['check']);
+
+    const correctedArchivedDocs = '---\ntitle: Documentation\n---\n\ncorrected archived docs\n';
+    await write(
+      root,
+      'docs/versions/0.9.0/website/src/content/docs/index.mdx',
+      correctedArchivedDocs,
+    );
+    runScript(root, ['publish', 'v0.9.0']);
+    expect(await read(root, 'docs/versions/0.9.0/website/src/content/docs/index.mdx')).toBe(
+      correctedArchivedDocs,
+    );
+
+    const archivedDocsRoot = resolve(root, 'docs/versions/0.9.0/website/src/content/docs');
+    await rm(archivedDocsRoot, { recursive: true, force: true });
+    expect(() => runScript(root, ['check'])).toThrow();
+    await write(
+      root,
+      'docs/versions/0.9.0/website/src/content/docs/index.mdx',
+      correctedArchivedDocs,
+    );
+    const linkedPage = resolve(archivedDocsRoot, 'linked.mdx');
+    await symlink('index.mdx', linkedPage);
+    expect(() => runScript(root, ['check'])).toThrow();
+    await rm(linkedPage);
+    runScript(root, ['check']);
+
+    delete archivedManifest.versions[0].commit;
+    await write(root, 'docs/versions/manifest.json', `${JSON.stringify(archivedManifest)}\n`);
+    expect(() => runScript(root, ['check'])).toThrow();
+  }, 30_000);
+});
+
+async function write(root: string, path: string, content: string) {
+  const destination = resolve(root, path);
+  await mkdir(resolve(destination, '..'), { recursive: true });
+  await writeFile(destination, content, 'utf8');
+}
+
+async function read(root: string, path: string) {
+  return readFile(resolve(root, path), 'utf8');
+}
+
+function git(root: string, args: string[]) {
+  return execFileSync('git', args, { cwd: root, encoding: 'utf8', stdio: 'pipe' });
+}
+
+function runScript(root: string, args: string[]) {
+  execFileSync('node', [script, ...args], {
+    cwd: root,
+    env: { ...process.env, HERDR_DOCS_REPO_ROOT: root },
+    stdio: 'pipe',
+  });
+}