/** * Generates the Devin Desktop (Windsurf) changelog and releases pages from the * public release feeds. * * It fetches the list of available versions from the updater's `/api/versions` * endpoint for each release channel (stable and next) and emits two Mintlify * changelog pages (https://www.mintlify.com/docs/create/changelogs) per channel, * each with one `` block per version: * * - changelog page: release notes (text) plus a collapsible per-OS download * block per version, wrapped in ``. * The newest version additionally gets an open-by-default accordion so it * stands out. When a note exists at * `desktop/releases//.md` it is imported (relative path) * and rendered; otherwise a placeholder line is used. * - releases page: per-OS download buttons only, rendered by the `` * component fed the download URLs from the API manifest. * * It also emits a changelog page for the Windsurf JetBrains plugin pre-release * channel. The JetBrains plugin has no updater API or per-OS downloads, so its * versions, dates and notes all come from the changelog index published to the * exafunction.github.io CDN (one `release-notes.mdx` per version, carrying the * version and release date in its frontmatter). * * Outputs: * - stable: desktop/changelog.mdx + desktop/releases.mdx * - next: desktop/changelog-next.mdx + desktop/releases-next.mdx * - jetbrains (next): windsurf/plugins/changelog-next.mdx * * Usage: * node scripts/generate_desktop_changelog.js * npm run generate-changelog * * The desktop source endpoints can be overridden with the VERSIONS_API_URL * (stable) and VERSIONS_API_URL_NEXT (next) env vars. The JetBrains pre-release * source can be overridden with JETBRAINS_NEXT_INDEX_URL, or read from a local * checkout of exafunction.github.io via JETBRAINS_NEXT_SOURCE_DIR (pointing at * its `public/changelog` directory). */ const fs = require("node:fs"); const path = require("node:path"); const process = require("node:process"); const ROOT = path.join(__dirname, ".."); const DESKTOP_DIR = path.join(ROOT, "desktop"); const PLUGINS_DIR = path.join(ROOT, "windsurf", "plugins"); // Import for the component. Mintlify only resolves reusable component // exports from the top-level /snippets dir (imported by absolute path), so the // component lives there rather than alongside the generated pages. const RELEASE_COMPONENT_IMPORT = 'import { Release } from "/snippets/Release.mdx";'; const CHANNELS = [ { name: "stable", apiUrl: process.env.VERSIONS_API_URL || "https://windsurf-stable.codeium.com/api/versions", notesDir: path.join(DESKTOP_DIR, "releases", "stable"), notesImportBase: "./releases/stable", changelogPath: path.join(DESKTOP_DIR, "changelog.mdx"), releasesPath: path.join(DESKTOP_DIR, "releases.mdx"), changelogTitle: "Changelog", changelogDescription: "Release notes for Devin Desktop (Windsurf).", releasesTitle: "Releases", releasesDescription: "Download Devin Desktop (Windsurf) releases.", }, { name: "next", apiUrl: process.env.VERSIONS_API_URL_NEXT || "https://windsurf-next.codeium.com/api/versions", notesDir: path.join(DESKTOP_DIR, "releases", "next"), notesImportBase: "./releases/next", changelogPath: path.join(DESKTOP_DIR, "changelog-next.mdx"), releasesPath: path.join(DESKTOP_DIR, "releases-next.mdx"), changelogTitle: "Changelog (Next)", changelogDescription: "Release notes for Devin Desktop (Windsurf) Next builds.", changelogIntro: "Download Next builds from the [Releases (Next)](/desktop/releases-next) page.", releasesTitle: "Releases (Next)", releasesDescription: "Download Devin Desktop (Windsurf) Next builds.", releasesIntro: "The Next edition of Devin Desktop is a beta build that includes previews of upcoming features. It gives early access to new features and releases more frequently than the stable build, but also may have bugs.", }, ]; // Windsurf JetBrains plugin changelogs. Sourced from the CDN changelog indexes // (or a local checkout), not the updater API. When JETBRAINS_SOURCE_DIR is set // it is used as the `public/changelog` directory for both channels. const JETBRAINS_SOURCE_DIR = process.env.JETBRAINS_SOURCE_DIR || process.env.JETBRAINS_NEXT_SOURCE_DIR || null; const JETBRAINS_CHANNELS = [ { name: "jetbrains-stable", indexUrl: process.env.JETBRAINS_INDEX_URL || "https://exafunction.github.io/public/changelog/jetbrains/jetbrains_changelogs.json", sourceDir: JETBRAINS_SOURCE_DIR, notesDir: path.join(PLUGINS_DIR, "releases", "jetbrains-stable"), notesImportBase: "./releases/jetbrains-stable", changelogPath: path.join(PLUGINS_DIR, "changelog.mdx"), changelogTitle: "Changelog", changelogDescription: "Release notes for the Windsurf JetBrains plugin.", }, { name: "jetbrains-next", indexUrl: process.env.JETBRAINS_NEXT_INDEX_URL || "https://exafunction.github.io/public/changelog/jetbrains-prerelease/jetbrains-prerelease_changelogs.json", sourceDir: JETBRAINS_SOURCE_DIR, notesDir: path.join(PLUGINS_DIR, "releases", "jetbrains-next"), notesImportBase: "./releases/jetbrains-next", changelogPath: path.join(PLUGINS_DIR, "changelog-next.mdx"), changelogTitle: "Changelog (Pre-release)", changelogDescription: "Release notes for the Windsurf JetBrains plugin pre-release builds.", }, ]; function frontmatter(title, description, icon, { rss = false } = {}) { const rssLine = rss ? "rss: true\n" : ""; return `--- title: "${title}" description: "${description}" icon: "${icon}" public: true ${rssLine}--- `; } // Next versions look like "2.3.1015+next.c46c49e94b"; strip the channel suffix // to get the displayable, sortable version (e.g. "2.3.1015"). function cleanVersion(version) { return version.split(/-next|\+next/)[0]; } // Converts an API platform key (e.g. "darwin-arm64-dmg") into the camelCase prop // name passed to (e.g. "darwinArm64Dmg"). function platformProp(platformKey) { return platformKey.replace(/-([a-z0-9])/g, (_, char) => char.toUpperCase()); } // Builds the per-OS download attributes (e.g. ` darwinArm64="https://..."`) for a // version from its manifest, one per platform that exposes a download URL. function renderDownloadAttributes(manifest) { return Object.entries(manifest || {}) .filter(([, entry]) => entry && typeof entry.url === "string") .map(([platformKey, entry]) => `${platformProp(platformKey)}="${entry.url}"`) .map((attribute) => ` ${attribute}`) .join(""); } /** * Picks a representative release date for a version from its per-platform * manifests. Each platform entry carries a millisecond epoch `timestamp`; we * use the most recent one as the version's release date. */ function releaseDateFor(manifest) { const timestamps = Object.values(manifest || {}) .map((entry) => entry && entry.timestamp) .filter((ts) => typeof ts === "number" && ts > 0); if (timestamps.length === 0) { return null; } return new Date(Math.max(...timestamps)); } function formatDate(date) { return date.toLocaleDateString("en-US", { year: "numeric", month: "long", day: "numeric", timeZone: "UTC", }); } function updateOpen(version, manifest) { const date = releaseDateFor(manifest); const description = date ? ` description="${formatDate(date)}"` : ""; return ``; } // A version such as "2.3.15" maps to a valid MDX/JS component identifier like // "Release_2_3_15". Returns null when no release note exists for the version. function snippetComponentName(channel, version) { if (!fs.existsSync(path.join(channel.notesDir, `${version}.md`))) { return null; } return `Release_${version.replace(/[^a-zA-Z0-9]+/g, "_")}`; } // Changelog entry: release note text plus a collapsible per-OS download block. // The newest release (isLatest) gets an open-by-default accordion so it stands // out from the rest of the history. function renderChangelogUpdate(channel, version, manifest, isLatest) { const componentName = snippetComponentName(channel, version); const note = componentName ? `<${componentName} />` : "A release was made."; const lines = [updateOpen(version, manifest), note]; const downloads = renderDownloadAttributes(manifest); if (downloads) { const accordionOpen = isLatest ? " defaultOpen" : ""; lines.push( ``, ``, `` ); } lines.push(``); return lines.join("\n"); } // Releases entry: per-OS download buttons only. function renderReleaseUpdate(version, manifest) { const downloads = renderDownloadAttributes(manifest); return [ updateOpen(version, manifest), ``, ``, ].join("\n"); } // Compares two dotted numeric versions (e.g. "2.3.15" vs "1.9600.41") so they // can be sorted newest-first. Each segment is compared numerically; shorter // versions sort before longer ones when otherwise equal. function compareVersionsDesc(a, b) { const segmentsA = a.split(".").map(Number); const segmentsB = b.split(".").map(Number); const length = Math.max(segmentsA.length, segmentsB.length); for (let i = 0; i < length; i++) { const diff = (segmentsB[i] || 0) - (segmentsA[i] || 0); if (diff !== 0) { return diff; } } return 0; } function renderImport(channel, version) { const componentName = snippetComponentName(channel, version); if (!componentName) { return null; } return `import ${componentName} from "${channel.notesImportBase}/${version}.md";`; } async function fetchVersions(apiUrl) { const res = await fetch(apiUrl); if (!res.ok) { throw new Error(`Failed to fetch ${apiUrl}: ${res.status} ${res.statusText}`); } const versions = await res.json(); if (!Array.isArray(versions)) { throw new Error( `Unexpected response from ${apiUrl}: expected an array of versions` ); } return versions; } async function generateChannel(channel) { const versions = await fetchVersions(channel.apiUrl); // Collapse to one entry per displayable version (newest build wins), then sort // newest-first by numeric semver. const byVersion = new Map(); for (const entry of versions) { const version = cleanVersion(entry.version); if (!byVersion.has(version)) { byVersion.set(version, { version, manifest: entry.manifest }); } } const entries = [...byVersion.values()].sort((a, b) => compareVersionsDesc(a.version, b.version) ); const noteImports = entries .map((entry) => renderImport(channel, entry.version)) .filter(Boolean); const changelogUpdates = entries.map((entry, index) => renderChangelogUpdate(channel, entry.version, entry.manifest, index === 0) ); const releaseUpdates = entries.map((entry) => renderReleaseUpdate(entry.version, entry.manifest) ); const changelogIntro = channel.changelogIntro ? `${channel.changelogIntro}\n\n` : ""; const releasesIntro = channel.releasesIntro ? `${channel.releasesIntro}\n\n` : ""; const changelogBody = `${frontmatter( channel.changelogTitle, channel.changelogDescription, "clock-rotate-left", { rss: true } )}\n${RELEASE_COMPONENT_IMPORT}\n${noteImports.join("\n")}\n\n${changelogIntro}${changelogUpdates.join( "\n\n" )}\n`; const releasesBody = `${frontmatter( channel.releasesTitle, channel.releasesDescription, "download" )}\n${RELEASE_COMPONENT_IMPORT}\n\n${releasesIntro}${releaseUpdates.join("\n\n")}\n`; fs.writeFileSync(channel.changelogPath, changelogBody, "utf8"); fs.writeFileSync(channel.releasesPath, releasesBody, "utf8"); console.log( `[${channel.name}] wrote ${entries.length} releases to ${path.relative( ROOT, channel.changelogPath )} and ${path.relative(ROOT, channel.releasesPath)}` ); } // Minimal YAML frontmatter parser for the changelog notes (keys are simple // `key: "value"` / `key: 'value'` pairs). Returns the parsed fields and the // remaining markdown body. function parseFrontmatter(source) { const match = source.match(/^---\n([\s\S]*?)\n---\n?/); if (!match) { return { data: {}, body: source }; } const data = {}; for (const line of match[1].split("\n")) { const pair = line.match(/^([A-Za-z0-9_]+):\s*(.*)$/); if (pair) { data[pair[1]] = pair[2].trim().replace(/^['"]|['"]$/g, ""); } } return { data, body: source.slice(match[0].length) }; } // Resolves a CDN note URL to either its local checkout path (when sourceDir is // set) or returns the URL to be fetched. async function readNoteSource(channel, noteUrl) { if (channel.sourceDir) { const relative = noteUrl.split("/public/changelog/")[1]; return fs.readFileSync(path.join(channel.sourceDir, relative), "utf8"); } const res = await fetch(noteUrl); if (!res.ok) { throw new Error(`Failed to fetch ${noteUrl}: ${res.status} ${res.statusText}`); } return res.text(); } async function readJetbrainsIndex(channel) { if (channel.sourceDir) { const relative = channel.indexUrl.split("/public/changelog/")[1]; return JSON.parse( fs.readFileSync(path.join(channel.sourceDir, relative), "utf8") ); } const res = await fetch(channel.indexUrl); if (!res.ok) { throw new Error( `Failed to fetch ${channel.indexUrl}: ${res.status} ${res.statusText}` ); } return res.json(); } // Derives a version from a note URL when its frontmatter omits one. Handles // both layouts in the indexes: `...//release-notes.mdx` and the older // flat `.../.mdx`. function versionFromNoteUrl(noteUrl) { const last = noteUrl.split("/").pop(); if (last === "release-notes.mdx") { return noteUrl.split("/").slice(-2)[0]; } return last.replace(/\.mdx$/, ""); } // Generates a JetBrains plugin changelog page. Unlike the desktop channels, the // version, release date and notes all come from each version's release-notes // frontmatter + body; the stripped body is written next to the page and // imported per `` block. async function generateJetbrains(channel) { const noteUrls = await readJetbrainsIndex(channel); if (!Array.isArray(noteUrls)) { throw new Error(`Unexpected JetBrains index: expected an array of note URLs`); } const byVersion = new Map(); for (const noteUrl of noteUrls) { const source = await readNoteSource(channel, noteUrl); const { data, body } = parseFrontmatter(source); const version = data.version || versionFromNoteUrl(noteUrl); byVersion.set(version, { version, releaseDate: data.releaseDate, body }); } const entries = [...byVersion.values()].sort((a, b) => compareVersionsDesc(a.version, b.version) ); // Recreate the notes dir so removed versions don't linger. fs.rmSync(channel.notesDir, { recursive: true, force: true }); fs.mkdirSync(channel.notesDir, { recursive: true }); const imports = []; const updates = []; for (const entry of entries) { const componentName = `Release_${entry.version.replace(/[^a-zA-Z0-9]+/g, "_")}`; fs.writeFileSync( path.join(channel.notesDir, `${entry.version}.md`), `${entry.body.trim()}\n`, "utf8" ); imports.push( `import ${componentName} from "${channel.notesImportBase}/${entry.version}.md";` ); const date = entry.releaseDate ? new Date(entry.releaseDate) : null; const description = date && !Number.isNaN(date.getTime()) ? ` description="${formatDate(date)}"` : ""; updates.push( [ ``, `<${componentName} />`, ``, ].join("\n") ); } const body = `${frontmatter( channel.changelogTitle, channel.changelogDescription, "clock-rotate-left" )}\n${imports.join("\n")}\n\n${updates.join("\n\n")}\n`; fs.mkdirSync(path.dirname(channel.changelogPath), { recursive: true }); fs.writeFileSync(channel.changelogPath, body, "utf8"); console.log( `[${channel.name}] wrote ${entries.length} releases to ${path.relative( ROOT, channel.changelogPath )}` ); } async function main() { for (const channel of CHANNELS) { await generateChannel(channel); } for (const channel of JETBRAINS_CHANNELS) { await generateJetbrains(channel); } } main().catch((err) => { console.error(err); process.exit(1); });

​Terms of Service

Terms of Service