自动生成 Conventional Changelog:用 AI 提炼 Git 提交记录的提示词链

在开源项目和商业化系统软件的交付流程中,每一次版本发布(Release)前编写一份清晰、专业、分类明确的 更新日志(Changelog) 是必不可少的工程环节。
然而,在经历了一周密集的开发后,Git 提交历史中往往充斥着几十条琐碎的提交记录(如 fix typo, wip parser, refactor error types, add test)。如果纯靠人工一条条比对并分类整理成符合社区标准的 CHANGELOG.md,通常要耗费半个多小时。
为了彻底解放这一重复性劳动,我设计了一套基于 Git Log 管道与大模型提示词链(Prompt Chain) 的自动化更新日志生成工作流。今天把这套脚本与提示词工程模板完整分享出来。
1. 结构化输入:提取规范的 Git 日志流
首先,我们需要从 Git 仓库中提取出从上一个 Tag 到当前 HEAD 之间的所有提交信息。
使用带有特定格式的 git log 命令:
# 提取自 v0.1.0 标签以来的结构化提交(哈希、作者、提交主题、提交内容)
git log v0.1.0..HEAD --pretty=format:"* %h - %s (%an)" --no-merges
输出的原始日志样本:
* a1b2c3d - feat(tcp): 实现基于滑动窗口的乱序重组状态机 (陈一铭)
* e4f5g6h - fix(capture): 解决 macOS 下网卡混杂模式超时未生效问题 (陈一铭)
* 7890abc - perf(wasm): 使用 serde-wasm-bindgen 替代旧版 json 序列化 (陈一铭)
* d1e2f3a - docs: 补充 TCP 三次握手状态机时序流程图 (陈一铭)
* 4b5c6d7 - refactor(error): 将底层 IO 错误统一收拢为 Domain Error (陈一铭)
2. 自动化提炼脚本:scripts/generate-changelog.sh
在项目根目录下编写 Shell 脚本:
#!/usr/bin/env bash
# scripts/generate-changelog.sh
set -e
# 获取上一个 release tag,若无则取初始提交
PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || git rev-list --max-parents=0 HEAD)
CURRENT_VERSION="v0.2.0"
TODAY=$(date +%Y-%m-%d)
echo "正在收集自 [$PREV_TAG] 以来的 Git 提交记录..."
RAW_LOGS=$(git log ${PREV_TAG}..HEAD --pretty=format:"* %h | %s" --no-merges)
if [ -z "$RAW_LOGS" ]; then
echo "未检测到任何新增提交记录!"
exit 0
fi
# 构造结构化提示词
SYSTEM_PROMPT="你是一名负责一流开源 Rust 项目维护的发布经理。
请根据提供的原始 Git Log,生成一份符合 Keep a Changelog 与 Conventional Commits 规范的高质量发布日志(Markdown 格式)。
要求与分类标准:
1. 一级标题统一为: ## [$CURRENT_VERSION] - $TODAY
2. 严格按以下四个模块归类(没有的分组直接省略):
- ### 新特性 (Features)
- ### 🐛 缺陷修复 (Bug Fixes)
- ### ⚡ 性能优化 (Performance Improvements)
- ### 🔨 工程重构与文档 (Refactor & Docs)
3. 对每条日志进行提炼和润色:
- 提取业务价值与技术影响,语言简明专业,去除无意义的 WIP 提交;
- 保留原提交哈希(以 Markdown 行内代码格式展示,如 \`a1b2c3d\`);
4. 在文末追加一段由技术点构成的【版本亮点摘要】(3 句话以内)。"
echo "正在调用 AI 进行更新日志提炼..."
curl -s https://api.deepseek.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $DEEPSEEK_API_KEY" \
-d @- <<EOF | jq -r '.choices[0].message.content'
{
"model": "deepseek-chat",
"messages": [
{"role": "system", "content": "$SYSTEM_PROMPT"},
{"role": "user", "content": $(echo "$RAW_LOGS" | jq -s -R .)}
],
"temperature": 0.1
}
EOF
3. 生成的生产级 CHANGELOG.md 成果展示
运行 ./scripts/generate-changelog.sh,仅过了 3 秒钟,标准专业的 Markdown 更新日志便一气呵成:
## [v0.2.0] - 2026-09-08
### 新特性 (Features)
- `a1b2c3d` **TCP 会话重组**:实现基于滑动窗口与乱序队列的 TCP 报文重组状态机,支持完整数据流提取;
- `c7d8e9f` **多模型适配器**:引入统一 Trait 抽象,支持零改动无缝切换 DeepSeek、Claude 与本地 Ollama 离线推理。
### 🐛 缺陷修复 (Bug Fixes)
- `e4f5g6h` **网卡捕获修复**:修复 macOS 下在特定链路层类型时混杂模式超时未生效引发的挂起缺陷;
- `9a8b7c6` **自引用防范**:重构会话管理器结构,彻底消除循环借用引发的编译死锁。
### ⚡ 性能优化 (Performance Improvements)
- `7890abc` **WASM 序列化加速**:全量迁移至 `serde-wasm-bindgen`,前端跨语言对象映射吞吐量提升近 10 倍;
- `3d4e5f6` **内核缓冲扩容**:将底层捕获环形队列扩展至 32MB,千兆高并发压测下实现 18 万 PPS 零丢包。
### 🔨 工程重构与文档 (Refactor & Docs)
- `4b5c6d7` **错误处理分层**:基于 `thiserror` 细化链路层与传输层领域错误体系;
- `d1e2f3a` **架构图谱完善**:新增 TCP 三次握手与状态机流转详细 Mermaid 序列图。
> **版本亮点摘要**:
> 本次 v0.2.0 版本完成了从“单包解码”向“全连接状态流跟踪”的跨越,核心 TCP 重组引擎正式落地;同时打通了本地 Ollama 离线小模型推理支持,为高安全诉求的内网抓包分析提供了完整的数据隐私保障。
总结
这套自动化 Changelog 工作流的实操价值:
- 秒级提炼:将半小时的人工机械整理压缩到 3 秒以内;
- 消除低级错漏:自动关联 Git Commit Hash,杜绝遗漏重要特性;
- 格式高度统一:自动生成符合 GitHub Releases 规范的专业文案,极大提升了开源项目的门面形象。
503



被折叠的 条评论
为什么被折叠?



