CodeBuddy怎么做代码仓库的Commit规范检查?能根据Conventional Commits自动生成CHANGELOG吗

小磊大大_4194

小磊大大_4194

2026-05-20

231人浏览

原创

codebuddy可通过commitlint+husky校验提交格式、内置changelog插件自动生成changelog、/mr指令同步更新、ide插件实时预览四步实现规范化管理。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

codebuddy怎么做代码仓库的commit规范检查?能根据conventional commits自动生成changelog吗

如果您在使用 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 CLI for OpenClaw
CodeBuddy CLI for OpenClaw

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 文件供团队评审

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

codebuddy

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2549

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2088

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1060

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

998

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1236

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1898

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

2860

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

12295

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

509

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CodeBuddy 开放平台
CodeBuddy 开放平台

共0课时 | 0人学习

Codebuddy 插件
Codebuddy 插件

共0课时 | 0人学习

CodeBuddy官方文档
CodeBuddy官方文档

共0课时 | 0人学习