自动化工作流基于 Git Commit 与 LLM 的 Changelog 智能生成在产品快速迭代的过程中编写对外发布日志Changelog往往被开发者当作一项烦人的琐事。直接将原始的git log展示给最终用户充斥着大量的“fix typo”、“refactor db”等程序员内部术语对普通用户极不友好。本文设计并实现一套自动化 CLI 工具通过解析 Git 规范提交日志结合 LLM 将底层代码变更“翻译”为用户看得懂的商业语言 Changelog。flowchart LR A[Git Commit Log 历史记录] -- B[Standard Commit 节点过滤器] B --|过滤属于 feat / fix 的提交| C[提取 Git Diff 与抽象摘要] C -- D[构建语义转换 Prompt] D -- E[调用轻量 LLM 进行语言重构] E -- F[生成区分【新功能】与【修复优化】的出版级 Release Notes]一、为什么传统 Changelog 生成工具体验糟糕传统的 Changelog 工具如conventional-changelog完全依赖于正则表达式匹配 Commit 标题。如果开发者提交了feat: update user avatar component传统的工具生成的日志依然是冷冰冰的“更新了用户头像组件”。这种传统模式有三个缺陷缺乏用户视角User-Centric Perspective普通用户关心的不是“改了哪个组件”而是“这个更新能帮我解决什么问题”。噪音堆积重构代码refactor、修改 CI 脚本ci等内部维护工作不应该呈现在面向用户的更新日志中。语言单调无法将分散在多次 commit 中的微小修补聚合为一条完整的语义描述。结合 LLM我们可以实现从“代码逻辑变动”向“用户价值文案”的跨越。二、Git 规范 Commit 解析层首先我们需要从本地 Git 仓库中提取自上一次 Tag/Release 之后的所有提交日志并排除掉无意义的内部修改。// src/gitParser.ts import { execSync } from node:child_process; export interface ParsedCommit { hash: string; type: string; scope: string; subject: string; author: string; } /** * 提取自上一个 Tag 之后的所有规范 Commit */ export function getCommitsSinceLastTag(): ParsedCommit[] { let lastTag ; try { lastTag execSync(git describe --tags --abbrev0).toString().trim(); } catch { // 如果没有 Tag默认读取最近 20 条提交 lastTag ; } const range lastTag ? ${lastTag}..HEAD : -n 20; const rawLog execSync(git log ${range} --prettyformat:%h|%s|%an).toString().trim(); if (!rawLog) return []; const commits: ParsedCommit[] []; const lines rawLog.split(\n); // 正则解析 Conventional Commits 格式: type(scope): subject const commitRegex /^(\w)(?:\(([^)])\))?\s*:\s*(.)$/; for (const line of lines) { const [hash, message, author] line.split(|); const match commitRegex.exec(message); if (match) { const [, type, scope, subject] match; // 过滤仅提取面向用户的 feat (新功能) 和 fix (修复) if ([feat, fix, perf].includes(type.toLowerCase())) { commits.push({ hash, type: type.toLowerCase(), scope: scope || general, subject, author, }); } } } return commits; }三、结合 LLM 的用户语言“翻译”组件拿到过滤后的规范 Commit 列表后将其送入 LLM 转换组件。我们通过系统提示要求模型忽略底层细节以平易近人、富有活力的语气编写更新日志。// src/changelogGenerator.ts import { OpenAI } from openai; import { ParsedCommit } from ./gitParser; const openai new OpenAI(); export interface FormattedChangelog { versionTitle: string; features: string[]; bugFixes: string[]; performanceImprovements: string[]; } export async function generateUserFacingChangelog( commits: ParsedCommit[], versionName: string v1.2.0 ): Promisestring { const commitSummary commits .map((c) - [${c.type.toUpperCase()}] (${c.scope}) ${c.subject}) .join(\n); const prompt 你是一个顶级独立产品的专业产品经理与文案专家。请将以下程序员提交的 Git Commit 日志转换为一份面向最终用户的出版级更新日志 (Release Notes)。 【待转化 Commit 列表】 ${commitSummary} 【撰写要求】 1. 语言要求简体中文语气友好、专业、富有活力。 2. 视角转变不要出现“重构了组件”、“修改了函数”等技术词汇将其转化为对用户的具体价值描述如“修复了某些情况下导出会卡顿的问题”。 3. 结构划分分为 新功能、 问题修复 与 ⚡ 性能优化 三个板块。 4. 聚合同类项如果有多条 Commit 描述的是同一个功能将其合并为一条通顺的说明。 请直接输出 Markdown 格式的日志。; const response await openai.chat.completions.create({ model: gpt-4o-mini, messages: [ { role: system, content: 你只输出高清规范的 Markdown 排版日志。 }, { role: user, content: prompt } ], temperature: 0.2, }); return response.choices[0].message.content || ; }四、CLI 工具封装与自动化应用将解析与生成组件打包为一个本地 Node.js 命令行工具// bin/generate-changelog.ts #!/usr/bin/env node import fs from node:fs; import path from node:path; import { getCommitsSinceLastTag } from ../src/gitParser; import { generateUserFacingChangelog } from ../src/changelogGenerator; async function main() { console.log( 正在解析 Git 提交日志历史...); const commits getCommitsSinceLastTag(); if (commits.length 0) { console.log(⚠️ 未找到自上次发布以来的有效 feat/fix 提交无需更新 Changelog。); return; } console.log( 捕获到 ${commits.length} 条有效提交正在调用 AI 生成用户级 Changelog...); const markdown await generateUserFacingChangelog(commits); const outputPath path.resolve(process.cwd(), CHANGELOG.md); // 将新版本的 Changelog 顶部追加到既有 CHANGELOG.md 中 let existingContent ; if (fs.existsSync(outputPath)) { existingContent fs.readFileSync(outputPath, utf8); } const updatedContent ${markdown}\n\n---\n\n${existingContent}; fs.writeFileSync(outputPath, updatedContent, utf8); console.log(✨ 成功将 AI 生成的用户级 Release Notes 追加至 CHANGELOG.md); } main();五、生成的 Changelog 前后对比效果原生 Git Commit 记录程序员视角- feat(auth): add JWT refreshToken flow - fix(editor): fix selection offset issue in dark mode - perf(canvas): optimize OffscreenCanvas export memoryAI 智能转化后最终用户视角# 1.2.0 版本更新日志 ### 新增功能 - **更无感的登录体验**现在系统支持自动安全续期您不再需要频繁手动重新登录。 ### 问题修复 - **界面体验优化**修复了在暗黑模式下选中文本时可能出现的视觉偏置问题。 ### ⚡ 性能提升 - **导出速度加快**大幅优化了长图导出时的内存占用图片导出体验更加流畅。用确定性的 Git 规范解析过滤噪声再用 AI 翻译为有温度的用户语言是独立产品提升用户好感度的极低成本方式。
自动化工作流基于 Git Commit 与 LLM 的 Changelog 智能生成在产品快速迭代的过程中编写对外发布日志Changelog往往被开发者当作一项烦人的琐事。直接将原始的git log展示给最终用户充斥着大量的“fix typo”、“refactor db”等程序员内部术语对普通用户极不友好。本文设计并实现一套自动化 CLI 工具通过解析 Git 规范提交日志结合 LLM 将底层代码变更“翻译”为用户看得懂的商业语言 Changelog。flowchart LR A[Git Commit Log 历史记录] -- B[Standard Commit 节点过滤器] B --|过滤属于 feat / fix 的提交| C[提取 Git Diff 与抽象摘要] C -- D[构建语义转换 Prompt] D -- E[调用轻量 LLM 进行语言重构] E -- F[生成区分【新功能】与【修复优化】的出版级 Release Notes]一、为什么传统 Changelog 生成工具体验糟糕传统的 Changelog 工具如conventional-changelog完全依赖于正则表达式匹配 Commit 标题。如果开发者提交了feat: update user avatar component传统的工具生成的日志依然是冷冰冰的“更新了用户头像组件”。这种传统模式有三个缺陷缺乏用户视角User-Centric Perspective普通用户关心的不是“改了哪个组件”而是“这个更新能帮我解决什么问题”。噪音堆积重构代码refactor、修改 CI 脚本ci等内部维护工作不应该呈现在面向用户的更新日志中。语言单调无法将分散在多次 commit 中的微小修补聚合为一条完整的语义描述。结合 LLM我们可以实现从“代码逻辑变动”向“用户价值文案”的跨越。二、Git 规范 Commit 解析层首先我们需要从本地 Git 仓库中提取自上一次 Tag/Release 之后的所有提交日志并排除掉无意义的内部修改。// src/gitParser.ts import { execSync } from node:child_process; export interface ParsedCommit { hash: string; type: string; scope: string; subject: string; author: string; } /** * 提取自上一个 Tag 之后的所有规范 Commit */ export function getCommitsSinceLastTag(): ParsedCommit[] { let lastTag ; try { lastTag execSync(git describe --tags --abbrev0).toString().trim(); } catch { // 如果没有 Tag默认读取最近 20 条提交 lastTag ; } const range lastTag ? ${lastTag}..HEAD : -n 20; const rawLog execSync(git log ${range} --prettyformat:%h|%s|%an).toString().trim(); if (!rawLog) return []; const commits: ParsedCommit[] []; const lines rawLog.split(\n); // 正则解析 Conventional Commits 格式: type(scope): subject const commitRegex /^(\w)(?:\(([^)])\))?\s*:\s*(.)$/; for (const line of lines) { const [hash, message, author] line.split(|); const match commitRegex.exec(message); if (match) { const [, type, scope, subject] match; // 过滤仅提取面向用户的 feat (新功能) 和 fix (修复) if ([feat, fix, perf].includes(type.toLowerCase())) { commits.push({ hash, type: type.toLowerCase(), scope: scope || general, subject, author, }); } } } return commits; }三、结合 LLM 的用户语言“翻译”组件拿到过滤后的规范 Commit 列表后将其送入 LLM 转换组件。我们通过系统提示要求模型忽略底层细节以平易近人、富有活力的语气编写更新日志。// src/changelogGenerator.ts import { OpenAI } from openai; import { ParsedCommit } from ./gitParser; const openai new OpenAI(); export interface FormattedChangelog { versionTitle: string; features: string[]; bugFixes: string[]; performanceImprovements: string[]; } export async function generateUserFacingChangelog( commits: ParsedCommit[], versionName: string v1.2.0 ): Promisestring { const commitSummary commits .map((c) - [${c.type.toUpperCase()}] (${c.scope}) ${c.subject}) .join(\n); const prompt 你是一个顶级独立产品的专业产品经理与文案专家。请将以下程序员提交的 Git Commit 日志转换为一份面向最终用户的出版级更新日志 (Release Notes)。 【待转化 Commit 列表】 ${commitSummary} 【撰写要求】 1. 语言要求简体中文语气友好、专业、富有活力。 2. 视角转变不要出现“重构了组件”、“修改了函数”等技术词汇将其转化为对用户的具体价值描述如“修复了某些情况下导出会卡顿的问题”。 3. 结构划分分为 新功能、 问题修复 与 ⚡ 性能优化 三个板块。 4. 聚合同类项如果有多条 Commit 描述的是同一个功能将其合并为一条通顺的说明。 请直接输出 Markdown 格式的日志。; const response await openai.chat.completions.create({ model: gpt-4o-mini, messages: [ { role: system, content: 你只输出高清规范的 Markdown 排版日志。 }, { role: user, content: prompt } ], temperature: 0.2, }); return response.choices[0].message.content || ; }四、CLI 工具封装与自动化应用将解析与生成组件打包为一个本地 Node.js 命令行工具// bin/generate-changelog.ts #!/usr/bin/env node import fs from node:fs; import path from node:path; import { getCommitsSinceLastTag } from ../src/gitParser; import { generateUserFacingChangelog } from ../src/changelogGenerator; async function main() { console.log( 正在解析 Git 提交日志历史...); const commits getCommitsSinceLastTag(); if (commits.length 0) { console.log(⚠️ 未找到自上次发布以来的有效 feat/fix 提交无需更新 Changelog。); return; } console.log( 捕获到 ${commits.length} 条有效提交正在调用 AI 生成用户级 Changelog...); const markdown await generateUserFacingChangelog(commits); const outputPath path.resolve(process.cwd(), CHANGELOG.md); // 将新版本的 Changelog 顶部追加到既有 CHANGELOG.md 中 let existingContent ; if (fs.existsSync(outputPath)) { existingContent fs.readFileSync(outputPath, utf8); } const updatedContent ${markdown}\n\n---\n\n${existingContent}; fs.writeFileSync(outputPath, updatedContent, utf8); console.log(✨ 成功将 AI 生成的用户级 Release Notes 追加至 CHANGELOG.md); } main();五、生成的 Changelog 前后对比效果原生 Git Commit 记录程序员视角- feat(auth): add JWT refreshToken flow - fix(editor): fix selection offset issue in dark mode - perf(canvas): optimize OffscreenCanvas export memoryAI 智能转化后最终用户视角# 1.2.0 版本更新日志 ### 新增功能 - **更无感的登录体验**现在系统支持自动安全续期您不再需要频繁手动重新登录。 ### 问题修复 - **界面体验优化**修复了在暗黑模式下选中文本时可能出现的视觉偏置问题。 ### ⚡ 性能提升 - **导出速度加快**大幅优化了长图导出时的内存占用图片导出体验更加流畅。用确定性的 Git 规范解析过滤噪声再用 AI 翻译为有温度的用户语言是独立产品提升用户好感度的极低成本方式。
