Merge pull request #71 from a-thomas-22/at/elegant-tharp-025639

fix(redirects): serve legacy URL redirects in production via vercel.json

Author: pete-vielhaber

.github/workflows/redirects-in-sync.yml

@@ -0,0 +1,35 @@
+name: redirects-in-sync
+
+# Guarantees vercel.json matches redirects.config.js (the single source of
+# truth). Vercel reads vercel.json at the start of a deployment, so a commit
+# that edits redirects.config.js without regenerating vercel.json would ship
+# stale production redirects. This job regenerates the file and fails if it
+# differs from what's committed.
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      # No `npm install` needed: the sync script uses only Node built-ins and
+      # imports the local redirects.config.js.
+      - name: Regenerate vercel.json from redirects.config.js
+        run: node scripts/sync-vercel-redirects.mjs
+
+      - name: Fail if vercel.json is out of date
+        run: |
+          if [ -n "$(git status --porcelain vercel.json)" ]; then
+            echo "::error::vercel.json is out of sync with redirects.config.js. Run 'npm run sync-redirects' and commit the result."
+            git --no-pager diff vercel.json
+            exit 1
+          fi
+          echo "vercel.json is in sync with redirects.config.js."

package.json

@@ -3,6 +3,8 @@
   "type": "module",
   "scripts": {
     "dev": "vocs dev",
+    "sync-redirects": "node scripts/sync-vercel-redirects.mjs",
+    "prebuild": "node scripts/sync-vercel-redirects.mjs",
     "build": "vocs build",
     "preview": "vocs preview",
     "format": "prettier --write ."

redirects.config.d.ts

@@ -0,0 +1,6 @@
+export interface DocRedirect {
+  from: string;
+  to: string;
+}
+
+export declare const redirects: DocRedirect[];

redirects.config.js

@@ -0,0 +1,45 @@
+/**
+ * sync-vercel-redirects — mirror redirects.config.js into vercel.json.
+ *
+ * The list in redirects.config.js is the single source of truth. Vocs only
+ * applies it in local dev (via the middleware in vocs.config.tsx), so this
+ * script mirrors it into vercel.json so Vercel serves the redirects in
+ * production. Vercel reads vercel.json at the start of a deployment (before the
+ * build command runs), so the generated file is committed.
+ *
+ * Run with `npm run sync-redirects` (also runs on `npm run build` via prebuild).
+ *
+ * Patterned on OffchainLabs/arbitrum-docs (scripts/sync-vercel-redirects.ts).
+ * That repo splices a sentinel-bounded block into a hand-maintained vercel.json
+ * to coexist with manual entries; ZeroDev's vercel.json is fully generated, so
+ * here we (re)write it wholesale. Written as `.mjs` because this repo has no
+ * `tsx`; it imports the `.js` config natively.
+ */
+
+import { writeFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { redirects } from "../redirects.config.js";
+
+const root = path.join(path.dirname(fileURLToPath(import.meta.url)), "..");
+const vercelPath = path.join(root, "vercel.json");
+
+// permanent: false -> 307, matching the arbitrum-docs convention. Temporary
+// redirects aren't cached aggressively by browsers/crawlers, which keeps future
+// doc reorganizations easy to revert.
+const json =
+  JSON.stringify(
+    {
+      redirects: redirects.map(({ from, to }) => ({
+        source: from,
+        destination: to,
+        permanent: false,
+      })),
+    },
+    null,
+    2,
+  ) + "\n";
+
+await writeFile(vercelPath, json);
+console.log(`sync-redirects: wrote ${redirects.length} redirects into vercel.json.`);