代码审查是软件开发过程中的一项关键活动,它可以帮助团队发现潜在的缺陷和错误,提高代码质量,加快项目开发进度。代码审查可以通过检查代码规范、代码结构、代码文档、代码注释等方式来保证代码的质量和可读性。同时,它还可以促进团队成员之间的有效沟通和合作,提高团队的整体素质。
在代码审查中,团队成员通常需要花费大量的时间和精力来检查代码,这对于代码质量的提升非常有益。但是,随着代码库的增长和团队规模的扩大,代码审查也变得越来越困难。为了解决这个问题,我们可以借助一些工具来自动化代码审查的过程。其中,ChatGPT就是一个非常好的选择。
接下来介绍如何使用
1. 克隆仓库
git clone https://github.com/vok123/gpt-cr-bot.git
2. codeup 配置 src/config/index.ts
/** 企业标识id, 必填 */
export const organizationId = '企业标识id';
// 如何获取 accessKey: https://help.aliyun.com/document_detail/116401.htm
// 必填
export const accessKeyId = 'accessKeyId';
// 必填
export const accessKeySecret = 'accessKeySecret';
/** 定义chatgpt Api服务完整地址, 不填默认直接调用官方api(国内网络需要科学上网或者海外服务器) */
export const reverseProxyUrl = '';
/** gpt api key */
export const openaiApiKey = '';
3. 设置忽略code review文件或者目录
- 在项目中根目录新建
.cr-ignore
文件 - 输入需要忽略的文件
例子:
*/locales/*.json
dist/*
package.json
更多规则可参考 https://github.com/isaacs/minimatch
4. 启动服务
npm i
npm run dev
- 在服务器上启动运行
npm run start
5. codeup 开启推送评审模式
仓库 -> 设置 -> 推送规则设置 -> 推送评审模式[打开]
这个功能极大省去麻烦的合并步骤,一步到位 👍👍
6.项目仓库配置
- 进入仓库 -> 设置 -> Webhooks -> 新建Webhook
- URL中填入
${domain}/cr-bot/webhook
- 触发器只选择
合并请求事件
- 确定
7. 最后一步, 往目标分支推送代码
开启推送评审模式
后codeup将会创建临时的代码合并分支, 并为该临时分支创建一个合并到目标分支的合并请求
如果项目对你有用麻烦点点⭐star
⭐哦~
转载请注明出处, 谢谢~