#!/usr/bin/env node const fs = require("fs"); const path = require("path"); /** * Generates Mintlify entries from local changelog files. * * Usage: * node generate-release-notes.js [--source ] * * Default source: ../frontend/public/changelog * * Reads index.json + individual .md files from the source directory, * then prepends new entries to release-notes-webapp.mdx * above the existing historical entries. */ const RELEASE_NOTES_PATH = path.join( __dirname, "changelog", "release-notes-webapp.mdx" ); const FRONTMATTER = `--- title: App description: Follow along with the latest updates and improvements to Dovetail. --- `; function getSourceDir(args = process.argv.slice(2)) { const srcIdx = args.indexOf("--source"); if (srcIdx !== -1 && args[srcIdx + 1]) { return path.resolve(args[srcIdx + 1]); } return null; } function getPayloadPath(args = process.argv.slice(2)) { const payloadIdx = args.indexOf("--payload"); if (payloadIdx !== -1 && args[payloadIdx + 1]) { return path.resolve(args[payloadIdx + 1]); } return null; } function getDefaultSourceDir() { return path.resolve(__dirname, "..", "frontend", "public", "changelog"); } function parseSourceEntries(sourceDir) { console.log(`Reading changelog from ${sourceDir}`); const indexPath = path.join(sourceDir, "index.json"); if (!fs.existsSync(indexPath)) { console.error(`index.json not found at ${indexPath}`); process.exit(1); } const index = JSON.parse(fs.readFileSync(indexPath, "utf8")); console.log(`Found ${index.length} changelog entries`); return index.map((item) => ({ ...item, filePath: path.join(sourceDir, item.file), })); } function parsePayloadEntries(payloadPath) { console.log(`Reading changelog payload from ${payloadPath}`); if (!fs.existsSync(payloadPath)) { console.error(`Payload file not found at ${payloadPath}`); process.exit(1); } const payload = JSON.parse(fs.readFileSync(payloadPath, "utf8")); const entries = Array.isArray(payload.entries) ? payload.entries : []; console.log( `Found ${entries.length} dispatched changelog entr${ entries.length === 1 ? "y" : "ies" }` ); return entries.map((entry) => ({ ...entry, filePath: null, })); } function resolveEntries(options = {}) { if (options.payloadPath) { return parsePayloadEntries(options.payloadPath); } return parseSourceEntries(options.sourceDir || getDefaultSourceDir()); } function readEntryContent(entry) { if (typeof entry.content === "string") { return entry.content; } if (entry.filePath && fs.existsSync(entry.filePath)) { return fs.readFileSync(entry.filePath, "utf8"); } return null; } function getReleaseNotesPath(options = {}) { if (options.releaseNotesPath) { return path.resolve(options.releaseNotesPath); } return RELEASE_NOTES_PATH; } function generateReleaseNotes(options = {}) { const args = process.argv.slice(2); const payloadPath = options.payloadPath || getPayloadPath(args); const sourceDir = options.sourceDir || getSourceDir(args) || getDefaultSourceDir(); const releaseNotesPath = getReleaseNotesPath(options); const entries = resolveEntries({ payloadPath, sourceDir }); if (entries.length === 0) { console.log("No entries to process."); return; } let existingContent = ""; if (fs.existsSync(releaseNotesPath)) { existingContent = fs.readFileSync(releaseNotesPath, "utf8"); } const existingVersions = parseExistingVersions(existingContent); const newEntries = []; for (const entry of entries) { if (existingVersions.has(entry.title)) { console.log(` Skipping ${entry.title} (already exists)`); continue; } const raw = readEntryContent(entry); if (!raw) { console.warn(` Warning: ${entry.file || entry.title} not found, skipping`); continue; } const { frontmatter, body } = parseFrontmatter(raw); const date = frontmatter.date || entry.date; const title = frontmatter.title || entry.title; newEntries.push(generateUpdateEntry(date, title, body)); console.log(` Added ${title}`); } if (newEntries.length === 0) { console.log("No new entries to add. Release notes are up to date."); return; } let newContent; if (existingContent) { const firstDelim = existingContent.indexOf("---"); const secondDelim = existingContent.indexOf("---", firstDelim + 3); if (firstDelim !== -1 && secondDelim !== -1) { const afterFrontmatter = secondDelim + 3; const before = existingContent.slice(0, afterFrontmatter).trimEnd(); const after = existingContent.slice(afterFrontmatter).trimStart(); newContent = `${before}\n\n${newEntries.join("\n\n")}\n\n${after}\n`; } else { newContent = `${newEntries.join("\n\n")}\n\n${existingContent}`; } } else { newContent = FRONTMATTER + newEntries.join("\n\n") + "\n"; } fs.writeFileSync(releaseNotesPath, newContent, "utf8"); console.log( `\nSuccessfully wrote ${newEntries.length} new entr${ newEntries.length === 1 ? "y" : "ies" } to ${releaseNotesPath}` ); } function parseFrontmatter(raw) { const trimmed = raw.trim(); if (!trimmed.startsWith("---")) { return { frontmatter: {}, body: trimmed }; } const end = trimmed.indexOf("---", 3); if (end === -1) { return { frontmatter: {}, body: trimmed }; } const fmBlock = trimmed.slice(3, end).trim(); const body = trimmed.slice(end + 3).trim(); const frontmatter = {}; for (const line of fmBlock.split("\n")) { const colonIdx = line.indexOf(":"); if (colonIdx === -1) continue; const key = line.slice(0, colonIdx).trim(); const value = line.slice(colonIdx + 1).trim(); frontmatter[key] = value; } return { frontmatter, body }; } /** * Converts HTML

blocks to Mintlify components. */ function detailsToAccordion(body) { return body.replace( /

\s*

(.*?)<\/summary>([\s\S]*?)<\/details>/g, (_, title, content) => `\n${content.trim()}\n` ); } /** * Rewrites image src attributes that start with "/" to point to the * production frontend so assets resolve correctly in the docs site. */ function rewriteAssetPaths(body) { return body.replace( /(]*?src=")\/([^"]*")/g, "$1https://app.withdovetail.com/$2" ); } function generateUpdateEntry(date, title, body) { const converted = rewriteAssetPaths(detailsToAccordion(body)); return `\n**${title}**\n\n${converted}\n`; } function parseExistingVersions(content) { const versions = new Set(); // Match bold title line inside blocks: **Title** const regex = /]*>\s*\n\*\*([^*]+)\*\*/g; let match; while ((match = regex.exec(content)) !== null) { versions.add(match[1]); } return versions; } if (require.main === module) { generateReleaseNotes(); } module.exports = { detailsToAccordion, generateReleaseNotes, parseExistingVersions, parseFrontmatter, rewriteAssetPaths, };

​Export Text

​Export PDF

Export Text

Export PDF