Fix #207: support trailing-slash URLs

Author: gativarshney

.github/workflows/build.yml

@@ -78,3 +78,6 @@ jobs:
 
       - name: Build Next.js
         run: ${{ steps.pm.outputs.runner }} build
+
+      - name: Verify URL conventions
+        run: ${{ steps.pm.outputs.runner }} verify:urls

.github/workflows/deploy.yml

@@ -60,10 +60,12 @@ jobs:
             xsltproc \
             python3 \
             python3-pip
+      # Do NOT set `static_site_generator: next` here: it makes configure-pages
+      # write a `next.config.js`, which Next.js prefers over this repo's
+      # `next.config.ts`, so the deployed build silently ignores our config
+      # (#207). Everything it would inject is already in `next.config.ts`.
       - name: Setup Pages
         uses: actions/configure-pages@v5
-        with:
-          static_site_generator: next
       - name: Restore cache
         uses: actions/cache@v4
         with:
@@ -76,6 +78,9 @@ jobs:
         run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
       - name: Build with Next.js
         run: ${{ steps.detect-package-manager.outputs.runner }} build
+      # Blocks the deploy on broken URLs (#207); reads ./out, rebuilds nothing.
+      - name: Verify URL conventions
+        run: ${{ steps.detect-package-manager.outputs.runner }} verify:urls
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

AGENTS.md

@@ -50,6 +50,20 @@ If a PR changes generated output without changing the inputs that produce it, ca
 - A large part of the site is Markdown-driven. Review content pipeline changes for frontmatter assumptions, slug handling, excerpt/title sanitization, and image resolution.
 - This repo uses Yarn as the expected package manager. Flag changes that introduce package-manager drift or inconsistent lockfile/package-manager usage unless the migration is intentional.
 
+### URL conventions (see #207)
+
+- Canonical URLs have **no trailing slash**: `/some-page`. `next.config.ts` sets
+  `trailingSlash: false`, so the export writes `out/some-page.html` and GitHub
+  Pages serves it directly for `/some-page`.
+- Write internal links, canonical URLs, sitemap entries and RSS `<link>`s in
+  that form. Two deliberate exceptions: `/cups/` (separate CUPS Pages site) and
+  RSS `<guid>`s, which keep their historical trailing slash because they are
+  item identities -- changing them makes feed readers re-announce old articles.
+- `scripts/generate-trailing-slash-aliases.ts` writes `out/some-page/index.html`
+  redirect stubs after the export so old inbound links ending in `/` keep
+  working.
+- `yarn verify:urls` checks these invariants and gates both CI and deployment.
+
 ## Configuration & Portability
 
 - **Single Source of Truth**: All deployment-specific values, such as GitHub organization / repository names, base paths, and external URLs (e.g., Giscus configs, CI pipelines), are centralized in `config/site.config.ts`.

app/foomatic/driver/[id]/page.tsx

@@ -52,7 +52,7 @@ export async function generateMetadata({ params }: DriverPageProps): Promise<Met
     driver?.shortDescription ||
     `The ${name} printer driver in the OpenPrinting database` +
       (printerCount ? `, supporting ${printerCount} printer model${printerCount === 1 ? "" : "s"}.` : ".")
-  const canonical = getSiteUrl(`/foomatic/driver/${id}/`)
+  const canonical = getSiteUrl(`/foomatic/driver/${id}`)
 
   return {
     title,

app/foomatic/printer/[make]/[id]/page.tsx

@@ -54,7 +54,7 @@ export async function generateMetadata({ params }: PrinterPageProps): Promise<Me
   const description = printer
     ? `Support information, recommended driver, and ${driverCount} available driver${driverCount === 1 ? "" : "s"} for the ${name} on Linux and Unix via OpenPrinting.`
     : `Printer support information for ${id} from the OpenPrinting database.`
-  const canonical = getSiteUrl(`/foomatic/printer/${make}/${id}/`)
+  const canonical = getSiteUrl(`/foomatic/printer/${make}/${id}`)
 
   return {
     title,

app/gsod2020/[slug]/page.tsx

@@ -54,7 +54,7 @@ export default async function GSoD2020IdeaPage({
       <section className="py-10">
         <div className="mx-auto max-w-4xl px-6">
           <Link
-            href="/gsod2020/"
+            href="/gsod2020"
             className="inline-flex items-center gap-2 text-sm font-medium text-blue-600 hover:underline dark:text-blue-400"
           >
             <ArrowLeft className="h-4 w-4" />

app/gsod2020/page.tsx

@@ -72,7 +72,7 @@ export default async function GSoD2020Page() {
               {ideas.map((idea) => (
                 <Link
                   key={idea.slug}
-                  href={`/gsod2020/${idea.slug}/`}
+                  href={`/gsod2020/${idea.slug}`}
                   className="group block rounded-xl border border-border bg-card p-6 transition-all duration-300 hover:border-border/80 hover:bg-accent card-glow"
                 >
                   <div className="mb-4 flex items-start justify-between gap-3">

app/hall-of-fame/page.tsx

@@ -16,11 +16,11 @@ const ANNOUNCEMENT_PATH = "/OpenPrinting-News-The-New-OpenPrinting-Website"
 export const metadata: Metadata = {
   title,
   description,
-  alternates: { canonical: getSiteUrl("/hall-of-fame/") },
+  alternates: { canonical: getSiteUrl("/hall-of-fame") },
   openGraph: {
     title,
     description,
-    url: getSiteUrl("/hall-of-fame/"),
+    url: getSiteUrl("/hall-of-fame"),
     type: "website",
   },
 }

app/opportunity-open-source/page.tsx

@@ -17,12 +17,12 @@ export const metadata: Metadata = {
   title: "Opportunity Open Source | OpenPrinting",
   description:
     "OpenPrinting's annual free and open source software conference in India — the mission, past editions, and the upcoming one.",
-  alternates: { canonical: getSiteUrl("/opportunity-open-source/") },
+  alternates: { canonical: getSiteUrl("/opportunity-open-source") },
   openGraph: {
     title: "Opportunity Open Source | OpenPrinting",
     description:
       "OpenPrinting's annual free and open source software conference in India.",
-    url: getSiteUrl("/opportunity-open-source/"),
+    url: getSiteUrl("/opportunity-open-source"),
     type: "website",
   },
 }

app/sitemap.ts

@@ -25,35 +25,35 @@ function readDirSlugs(dir: string): string[] {
 
 const STATIC_ROUTES = [
   "/",
-  "/about-us/",
-  "/news/",
-  "/projects/",
-  "/downloads/",
-  "/documentation/",
-  "/upcoming-technologies/",
-  "/driverless/",
-  "/drivers/",
-  "/printers/",
-  "/foomatic/printers/",
-  "/foomatic/drivers/",
-  "/contact/",
-  "/donations/",
-  "/sponsors/",
-  "/opportunity-open-source/",
-  "/contribute/",
-  "/contribute-website/",
-  "/codeofconduct/",
-  "/achievements/",
-  "/history/",
-  "/current/",
-  "/databaseintro/",
-  "/gsoc/",
-  "/gsod/",
-  "/gsod2020/",
-  "/lfmp/",
-  "/lfmp2020/",
-  "/wsl-printer-app/",
-  "/wsl-printer-app-compile/",
+  "/about-us",
+  "/news",
+  "/projects",
+  "/downloads",
+  "/documentation",
+  "/upcoming-technologies",
+  "/driverless",
+  "/drivers",
+  "/printers",
+  "/foomatic/printers",
+  "/foomatic/drivers",
+  "/contact",
+  "/donations",
+  "/sponsors",
+  "/opportunity-open-source",
+  "/contribute",
+  "/contribute-website",
+  "/codeofconduct",
+  "/achievements",
+  "/history",
+  "/current",
+  "/databaseintro",
+  "/gsoc",
+  "/gsod",
+  "/gsod2020",
+  "/lfmp",
+  "/lfmp2020",
+  "/wsl-printer-app",
+  "/wsl-printer-app-compile",
 ];
 
 export default function sitemap(): MetadataRoute.Sitemap {
@@ -65,19 +65,19 @@ export default function sitemap(): MetadataRoute.Sitemap {
 
   for (const post of getAllPostRecords()) {
     entries.push({
-      url: getSiteUrl(`/${post.slug}/`),
+      url: getSiteUrl(`/${post.slug}`),
       lastModified: post.date || undefined,
     });
   }
 
   for (const slug of readDirSlugs("projects")) {
-    entries.push({ url: getSiteUrl(`/projects/${slug}/`) });
+    entries.push({ url: getSiteUrl(`/projects/${slug}`) });
   }
   for (const slug of readDirSlugs("documentation")) {
-    entries.push({ url: getSiteUrl(`/documentation/${slug}/`) });
+    entries.push({ url: getSiteUrl(`/documentation/${slug}`) });
   }
   for (const slug of readDirSlugs("upcoming-technologies")) {
-    entries.push({ url: getSiteUrl(`/upcoming-technologies/${slug}/`) });
+    entries.push({ url: getSiteUrl(`/upcoming-technologies/${slug}`) });
   }
 
   for (const route of foomaticRoutes()) {
@@ -97,7 +97,7 @@ function foomaticRoutes(): string[] {
       printers: { id: string; manufacturer: string }[];
     };
     for (const printer of data.printers) {
-      routes.push(`${printerHref(printer.id, printer.manufacturer)}/`);
+      routes.push(printerHref(printer.id, printer.manufacturer));
     }
   }
 
@@ -107,7 +107,7 @@ function foomaticRoutes(): string[] {
       drivers: { id: string }[];
     };
     for (const driver of data.drivers) {
-      routes.push(`${driverHref(driver.id)}/`);
+      routes.push(driverHref(driver.id));
     }
   }