chore: Analyse Next.js releases for app router changes

Having an email on every canary release can be too verbose,
I'm only interested in being notified of releases that
change the app router core code, which may impact `nuqs`.

Author: franky47

.github/workflows/test-against-nextjs-release.yml

@@ -62,3 +62,25 @@ jobs:
     steps:
       - name: Invalidate ISR cache for GitHub Actions status on landing page
         run: curl -s "https://nuqs.47ng.com/api/isr?tag=github-actions-status&token=${{ secrets.ISR_TOKEN }}"
+
+  analyse-release:
+    runs-on: ubuntu-latest
+    name: Check for app router changes
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+      - uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598
+        with:
+          version: 8
+      - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8
+        with:
+          node-version: lts/*
+          cache: pnpm
+      - name: Install dependencies
+        run: pnpm install
+      - name: Check for changes in app router
+        run: ./next-release-analyser.mjs
+        working-directory: packages/scripts
+        env:
+          MAILPACE_API_TOKEN: ${{ secrets.MAILPACE_API_TOKEN }}
+          EMAIL_ADDRESS_TO: ${{ secrets.EMAIL_ADDRESS_TO }}
+          EMAIL_ADDRESS_FROM: ${{ secrets.EMAIL_ADDRESS_FROM }}

packages/scripts/next-release-analyser.mjs

@@ -0,0 +1,97 @@
+#!/usr/bin/env zx
+// @ts-check
+
+import MailPace from '@mailpace/mailpace.js'
+import { createEnv } from '@t3-oss/env-core'
+import { z } from 'zod'
+import 'zx/globals'
+
+const canaryRegexp = /^(\d+)\.(\d+)\.(\d+)-canary\.(\d+)$/
+
+const env = createEnv({
+  server: {
+    MAILPACE_API_TOKEN: z.string(),
+    EMAIL_ADDRESS_FROM: z.string().email(),
+    EMAIL_ADDRESS_TO: z.string().email()
+  },
+  isServer: true,
+  runtimeEnv: process.env
+})
+
+main()
+
+const fileSchema = z.object({
+  filename: z.string(),
+  patch: z.string().optional()
+})
+
+async function main() {
+  const thisVersion = argv.version
+  const previousVersion = getPreviousVersion(argv.version)
+
+  if (!previousVersion) {
+    console.log('No previous version to compare with')
+    process.exit(0)
+  }
+  const compareURL = `https://api.github.com/repos/vercel/next.js/compare/v${previousVersion}...v${thisVersion}`
+  const compare = await fetch(compareURL).then(res => res.json())
+  const files = z.array(fileSchema).parse(compare.files)
+  const appRouterFile = files.find(
+    file =>
+      file.filename === 'packages/next/src/client/components/app-router.tsx'
+  )
+  if (!appRouterFile) {
+    console.log('No changes in app-router.tsx')
+    process.exit(0)
+  }
+  sendNotificationEmail(thisVersion, appRouterFile)
+}
+
+// --
+
+/**
+ * @param {string} version
+ */
+function getPreviousVersion(version) {
+  const match = canaryRegexp.exec(version)
+  if (!match || !match[4]) {
+    return null
+  }
+  const canary = parseInt(match[4])
+  if (canary === 0) {
+    return null
+  }
+  return `${match[1]}.${match[2]}.${match[3]}-canary.${canary - 1}`
+}
+
+/**
+ *
+ * @param {string} thisVersion
+ * @param {z.infer<typeof fileSchema>} appRouterFile
+ * @returns
+ */
+function sendNotificationEmail(thisVersion, appRouterFile) {
+  const client = new MailPace.DomainClient(env.MAILPACE_API_TOKEN)
+  const body = `Changes to the app router have been published in Next.js ${thisVersion}.
+
+Release: https://github.com/vercel/next.js/releases/tag/v${thisVersion}
+
+${
+  appRouterFile.patch
+    ? `The patch is:
+  \`\`\`diff
+  ${appRouterFile.patch}
+  \`\`\``
+    : 'No patch available'
+}
+`
+  console.info('Sending email')
+  console.info(body)
+  return client.sendEmail({
+    from: env.EMAIL_ADDRESS_FROM,
+    to: env.EMAIL_ADDRESS_TO,
+    subject: `[nuqs] Next.js ${thisVersion} has app router changes`,
+    textbody: body,
+    tags: ['nuqs']
+  })
+}

packages/scripts/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "scripts",
+  "private": true,
+  "version": "0.0.0-internal",
+  "type": "module",
+  "dependencies": {
+    "@mailpace/mailpace.js": "^0.1.1",
+    "@t3-oss/env-core": "^0.9.2",
+    "zod": "^3.22.4",
+    "zx": "^7.2.3"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3"
+  }
+}

packages/scripts/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    // Type checking
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "alwaysStrict": false, // Don't emit "use strict" to avoid conflicts with "use client"
+    // Modules
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    // Language & Environment
+    "target": "ESNext",
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    // Emit
+    "noEmit": true,
+    "declaration": true,
+    "declarationMap": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+
+    "downlevelIteration": true,
+    // Interop
+    "allowJs": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    // Misc
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo"
+  },
+  "include": ["next-release-analyser.mjs"],
+  "exclude": ["node_modules"]
+}