codebuddy可通过commitlint+husky校验提交格式、内置changelog插件自动生成changelog、/mr指令同步更新、ide插件实时预览四步实现规范化管理。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在使用 CodeBuddy 管理代码仓库时发现提交信息格式混乱、难以追溯变更意图,或 CHANGELOG 文件长期依赖人工维护而出现遗漏或不一致,则很可能是缺少对 Conventional Commits 规范的自动化校验与联动生成机制。以下是实现 Commit 规范检查及 CHANGELOG 自动化生成的具体方法:
一、通过 commitlint 配置 Git 提交钩子实施规范检查
该方法利用 commitlint 工具拦截不符合 conventional commits 格式的提交信息,在本地提交阶段即刻阻断不合规操作,确保每条 commit message 严格满足 type(scope): subject 结构要求。
1、在项目根目录执行命令安装 commitlint 及其约定式配置:
npm install --save-dev @commitlint/cli @commitlint/config-conventional
2、创建 commitlint.config.js 配置文件,内容为:
module.exports = { extends: ['@commitlint/config-conventional'] };
3、使用 Husky 初始化 Git 钩子:
npx husky install
4、添加 commit-msg 钩子,绑定 commitlint 检查:
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
5、完成上述配置后,任何未遵循 feat(auth): 添加 JWT 校验 或 fix(api): 修复空指针异常 等格式的提交都将被拒绝,并提示 Commit message 不符合 Conventional Commits 规范,请修正后重试。
二、启用 CodeBuddy 内置 CHANGELOG Generator Skill 实现自动构建
该方法直接调用 CodeBuddy 提供的 changelogplugin 技能,基于已通过 commitlint 校验的历史提交记录,按语义化类型(feat/fix/docs 等)自动聚类、排序并生成结构化 CHANGELOG.md 文件,无需额外脚本或手动整理。
1、确保项目已启用 CodeBuddy CLI 并完成初始化:
codebuddy init
2、在终端中运行以下命令触发自动生成:
codebuddy changelog generate
3、工具将扫描当前分支自上次 tag 以来的所有合规提交,提取 type、scope、subject 及正文内容,输出标准 Markdown 格式 CHANGELOG。
4、生成结果中,每个 feat 条目会自动归入“新功能”章节,每个 fix 条目归入“问题修复”,且所有条目按提交时间倒序排列。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手,支持自然语言驱动开发。 - 必备触发词:CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景:安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
三、结合 /mr 指令在 Merge Request 创建时同步更新 CHANGELOG
该方法将 CHANGELOG 生成嵌入团队协作流程,在发起 MR 时强制执行 changelog-updater 技能,确保每次集成都附带准确、实时的版本变更摘要,避免发布前集中补写导致的信息偏差。
1、在 IDE 或 CLI 中执行自定义指令:
/mr --changelog
2、CodeBuddy 自动执行三项动作:验证本地构建与测试通过、分析本次 MR 所含全部提交的语义类型、将新增条目追加至 CHANGELOG.md 头部“Unreleased”区块。
3、MR 描述区将自动填充如下结构化内容:
## Unreleased
### Features
- feat(ui): 新增响应式导航栏
### Bug Fixes
- fix(auth): 修复登录态丢失问题
4、若某次 MR 包含多个 scope(如 auth/ui/api),生成器将自动按 scope 分组展示,提升可读性。
四、使用 CodeBuddy IDE 插件在提交界面实时预览 CHANGELOG 差异
该方法面向高频单点提交场景,在 VS Code 或 JetBrains IDE 的 Git 提交面板中,于输入 commit message 前即可预览本次变更将如何影响下一份 CHANGELOG,实现“所见即所得”的规范控制。
1、打开 IDE 的 Git 面板,确认待提交文件已暂存。
2、点击 commit message 输入框右侧的 “Preview Changelog” 按钮。
3、插件立即调用本地模型分析 staged diff 与历史提交上下文,弹出浮层显示模拟生成的 CHANGELOG 片段。
4、若当前暂存区变更被识别为 feat(core): 重构状态管理模块,则浮层中将高亮显示该条目将出现在下一个版本的“新功能”章节中。
5、预览内容支持一键插入到当前 commit message 中,也可导出为临时 Markdown 文件供团队评审。










