本案例演示如何驱动 Codex 通过分析代码改动(Diff),自动生成专业、准确的版本发布说明(Release Notes)和 Commit Message。
1. 任务背景
完成了一轮复杂的功能迭代,涉及多个文件和模块。手动整理更新日志既费时又容易遗漏关键点。
2. 第一步:提取改动证据
要求 Codex 基于真实的 Git 差异进行总结,而不是凭空编造。
Prompt 示例:
``text
请分析本次任务的所有 Git Diff,不要编造不存在的功能。
要求:
- 列出所有被修改、新增或删除的文件。
- 新特性 (New Features):描述新增的核心功能。
- 优化与修复 (Improvements & Bugfixes):列出性能优化和已解决的问题。
- 破坏性改动 (Breaking Changes):如果涉及 API 变更,请特别标注。
- 配置变更:列出新增的环境变量或配置项。
- 简洁明了。
- 真实性核对:检查生成的说明中是否包含未实施的改动。
- 存档:将生成的 Release Notes 更新到项目的 CHANGELOG.md` 中。
2. 用中文简述每个文件的核心改动点。
3. 识别出本次版本中最重要的 3 个功能更新。
`
3. 第二步:生成结构化的发布日志
根据交付场景(面向用户或面向技术团队),定制输出格式。
Prompt 示例:
`text
请帮我生成一份版本发布说明(Release Notes)。
格式要求:
`
4. 第三步:优化 Commit Message
利用 AI 摆脱“fix”, “update”等毫无意义的提交信息。
Prompt 示例:
`text
请基于上述分析,为我提供 3 个符合 Conventional Commits 规范的提交信息候选。
例如:feat(auth): 新增 GitHub OAuth 登录支持
要求:
2. 包含具体的模块作用域。
3. 严禁使用模糊的营销词汇。
`
5. 验收与存档
---
下一篇推荐:实战案例:让 Codex 优化静态网站首页 —— 回到起点,通过视觉优化提升项目展示力。