GitLab CI/CD 配置指南
GitLab CI/CD 配置指南
本文档介绍如何为项目添加 GitLab CI/CD 配置,包括分支管理和流水线配置的完整流程。
1. 创建并配置主分支
1.1 创建 main 分支
从 master 分支创建 main 分支,作为项目的主要开发分支。

点击"创建分支"按钮,选择从 master 分支创建:

1.2 设置默认分支
进入项目设置 → 仓库配置页面:

将 main 分支设置为默认分支:

设置完成后,项目首页将默认显示 main 分支:

1.3 配置分支保护
为了确保代码质量和规范开发流程,需要将关键分支设置为保护分支,防止直接推送代码:
主分支保护
将 main 分支设置为保护分支:

环境分支保护
根据分支管理规范,还需要设置 qa 和 uat 环境分支的保护规则:
qa 分支保护:
- 分支名称:
qa - 推送权限:仅管理员
- 合并权限:仅管理员
- 用途:测试环境专用分支
- 分支名称:
uat 分支保护:
- 分支名称:
uat - 推送权限:仅管理员
- 合并权限:仅管理员
- 用途:演示环境专用分支
- 分支名称:
重要提示:设置分支保护后,所有代码变更必须通过合并请求(Merge Request)进行,这有助于:
- 代码审查和质量控制
- 确保 CI/CD 流水线正常执行
- 维护代码历史的完整性
- 环境分支的安全管理,避免误操作影响测试和演示环境
2. 创建发布分支
从 main 分支创建 release 分支,用于版本发布管理:

说明:
release分支的保护配置是可选的。在后续 CI 流程执行过程中,系统会根据配置自动将其设置为保护分支,确保发布流程的安全性。
3. 配置 CI/CD 流水线
3.1 创建 CI 配置分支
从 release 分支创建 feature/adapter-ci 分支,专门用于添加 CI 配置文件:

3.2 添加 GitLab CI 配置文件
在 feature/adapter-ci 分支中创建 .gitlab-ci.yml 文件,配置内容如下:
include:
- project: 'aikero/devops/ci-templates'
ref: main
file: 'pipeline.yml'说明:此配置引用了统一的 CI/CD 模板,确保项目间的一致性和可维护性。
完成文件创建后,提交并推送分支到远程仓库。
4. 合并 CI 配置
4.1 创建合并请求
在 feature/adapter-ci 分支创建合并请求(Merge Request),目标分支为 release:

4.2 等待流水线执行
提交合并请求后,GitLab 将自动触发 CI/CD 流水线。等待所有检查任务完成:

4.3 完成合并
流水线执行成功后,点击合并按钮完成代码合并:

5. 验证配置结果
合并完成后,检查 release 分支是否包含自动生成的 CHANGELOG.md 文件:

总结
通过以上步骤,您已经成功为项目配置了 GitLab CI/CD 流水线。配置完成后,项目将具备以下能力:
- ✅ 自动化构建和测试
- ✅ 版本管理和变更日志生成
- ✅ 统一的部署流程
- ✅ 代码质量检查
注意事项
- 分支保护:建议为以下分支设置保护规则,要求通过合并请求进行代码合并:
main:主分支,所有人员可创建 MR,管理员可合并release:发布分支,根据需要设置保护(CI 流程会自动处理)qa:测试环境分支,仅管理员可推送和合并uat:演示环境分支,仅管理员可推送和合并
- 权限管理:确保团队成员具有适当的项目访问权限
- 模板更新:定期关注 CI 模板的更新,及时同步最新的最佳实践
- 环境分支管理:qa/uat 分支作为固定环境分支,不随功能变换,确保测试和演示环境的稳定性
