Gitee 研发协作平台怎么用?代码扫描与持续集成操作教程
Gitee 是国内领先的代码托管与研发协作平台,集代码管理、团队协作、持续集成等功能于一体。对于开发者来说,掌握 Gitee 的使用方法,尤其是代码扫描和持续集成操作,能极大提升开发效率和代码质量。
? 一、基础操作入门
Gitee 的基础操作包括注册登录、创建仓库、代码提交等。首先,访问 Gitee 官网(Gitee - 基于 Git 的代码托管和研发协作平台),点击页面右上角的 “注册” 按钮,可选择邮箱注册或通过第三方账号登录。注册完成后,登录账号,点击页面右上角的 “+” 号,选择 “新建仓库”,填写仓库名称、描述等信息,选择仓库可见性,建议勾选初始化 README.md 文件,方便记录项目基本信息。
安装 Git 客户端后,在本地选择合适位置创建文件夹,打开 Git Bash 或终端,使用
git init
命令初始化本地仓库。在 Gitee 仓库页面找到 SSH 或 HTTPS 地址,执行 git remote add origin (仓库地址)
命令关联远程仓库,再通过 git pull origin master
拉取代码。在本地编辑代码后,使用
git add
命令将文件添加到暂存区,git commit -m "提交描述"
提交到本地仓库,最后执行 git push origin master
将代码推送到 Gitee 远程仓库。?️ 二、代码扫描实战
Gitee Scan 是一款静态代码扫描工具,支持多种主流语言,可对源代码进行语法、结构、过程、接口等分析,帮助团队快速发现代码中的缺陷和规范问题。
(一)全量扫描
全量扫描是对整个仓库分支进行全面的代码检查。首先,在 Gitee 仓库页面点击 “管理” 按钮,进入仓库管理界面,选择 “成员管理” 邀请团队成员,并为成员分配相应权限。然后,确认在【GiteeScan】中创建了对应的被检模块,未创建的话可通过仓库下的设置跳转至创建页面,输入相关内容完成创建。
被检模块创建完成后,前往仓库页面,选择【服务 - GiteeScan】,点击【新建扫描】,填写相关内容即可发起全量扫描。扫描完成后,点击列表中的【查看】项,进入查看扫描报告,了解代码的缺陷和规范情况。
(二)增量扫描
增量扫描主要针对新增的 Pull Request 或代码提交进行检测。同样需要先创建被检模块,在创建被检模块时选择代码提交触发或创建代码评审触发。
创建完成后,对应仓库下提交代码或创建 PR 即可触发增量扫描。在 Pull Request 页面可以查看扫描报告,了解新增代码的质量情况。
? 三、持续集成配置
Gitee Go 是 Gitee 提供的持续集成工具,支持自动化构建、测试和部署,可将项目持续集成并部署到指定主机环境中。
(一)开通服务与配置制品库
在企业版仓库中找到「DevOps」菜单中的「Gitee Go」功能,点击「同意并开通 Gitee Go」,完成服务开通。
制品库用于存放和管理 CI 过程产生的构建物,如二进制构建物、测试报告等。通过 Gitee Go 流水线页面找到「制品库管理」功能,创建一个制品库并设定唯一标识,例如创建一个名为 “编译制品”,唯一标识为 “compiled-artifact” 的制品库。
(二)添加部署机器
在 Gitee Go 中,“计算资源管理” 功能用于管理主机资源。企业管理员通过访问企业版「管理 - 功能设置 - 计算资源管理」进行设置。
首先创建主机组,例如创建名为 “后端服务”,唯一标识为 “backend-server” 的主机组。在创建完主机组后,通过主机组「主机管理」选项添加新主机,选择「添加新主机」,在弹出的界面中获取到 Agent 的安装脚本,复制到目标机器上执行,安装完成后,勾选在线的主机,点击「添加主机」即可。
(三)流水线配置
以构建一个 Golang 版本的 HTTP Web Server 程序为例,在仓库中创建流水线。具体步骤如下:
- 定义流水线:在仓库根目录创建
.gitee-ci.yml
文件,配置流水线名称、触发器、阶段和步骤等信息。例如,定义一个名为 “Golang - 流水线示例” 的流水线,设置 master 分支在产生代码 push 时精确触发构建。
- 构建步骤配置:在流水线中配置构建步骤,如采用 Golang 编译环境,指定 Golang 版本,编写构建脚本等。例如,使用
echo
命令创建并编译一个输出 “Hello, Gitee Go” 的程序。
- 部署与检测:在部署步骤中,将构建好的程序部署到目标机器,并通过
curl
检测服务启动情况。
完成流水线配置后,向仓库提交代码即可触发构建,通过浏览器访问对应目标机器服务查看效果。
? 四、团队协作与最佳实践
Gitee 提供了丰富的团队协作功能,如 Issues 管理、Wiki 文档、代码审查等,能有效提升团队开发效率和透明度。
在仓库页面点击 “Issues” 标签,可新建 Issue 记录项目中的问题、任务、需求等,团队成员可针对每个 Issue 进行讨论、更新状态。Wiki 功能可用于创建项目文档,如项目介绍、使用指南、开发规范等,方便团队成员共享知识和信息。
代码审查是保证代码质量的重要环节,在 Pull Request 页面,团队成员可以评论代码、提出修改建议,管理员审核通过后再合并代码。此外,Gitee 还支持分支管理,建议使用
master
分支作为稳定版本,develop
分支作为开发版本,为每个功能或 Bug 修复创建单独的分支,开发完成后合并到 develop
分支。? 五、常见问题与解决方案
在使用 Gitee 的过程中,可能会遇到一些问题。例如,代码提交时提示 “权限 denied”,可能是因为未配置 SSH 密钥,需要在 Gitee 中添加 SSH 公钥。如果代码冲突,需要手动解决冲突并提交更改。
对于代码扫描中出现的误报,可以通过自定义扫描方案和规则集来调整检测策略。在持续集成过程中,如果构建失败,可查看构建日志,检查脚本命令、依赖环境等是否配置正确。
通过以上步骤和方法,开发者可以快速上手 Gitee 研发协作平台,实现代码扫描和持续集成的自动化操作,提升团队开发效率和代码质量。
【该文章由dudu123.com嘟嘟 ai 导航整理,嘟嘟 AI 导航汇集全网优质网址资源和最新优质 AI 工具】