macos-tools/gitlab/ci-templates

GitLab CI/CD 模板

本目录包含了适用于不同类型项目的 GitLab CI/CD 配置模板。

模板文件

1. .gitlab-ci.yml.stock

适用于股票相关项目的完整 CI/CD 流水线配置。

特性：

• 支持多语言项目 (Node.js, Python)
• 完整的测试流水线 (单元测试、代码质量检查)
• Docker 镜像构建和推送
• 安全漏洞扫描
• 开发和生产环境部署
• 缓存优化
• 测试覆盖率报告

使用方法：

# 复制到你的项目根目录
cp .gitlab-ci.yml.stock /path/to/your/project/.gitlab-ci.yml

2. .gitlab-ci.yml.simple

简化的 CI/CD 配置，适用于快速开始。

特性：

• 基础测试
• 简单的 Docker 构建
• 手动部署到开发环境
• 适合小型项目或原型开发

环境变量配置

在 GitLab 项目中需要配置以下环境变量：

基础配置

• CI_REGISTRY_PASSWORD: GitLab Container Registry 密码
• CI_REGISTRY_USER: GitLab Container Registry 用户名

部署配置 (可选)

• SSH_PRIVATE_KEY: 部署服务器的 SSH 私钥
• DEPLOY_SERVER: 部署服务器地址
• DEPLOY_USER: 部署服务器用户名

数据库配置 (测试环境)

• DATABASE_URL: 测试数据库连接字符串
• REDIS_URL: Redis 连接字符串

Runner 标签说明

确保你的 GitLab Runner 配置了以下标签：

• docker: 用于运行 Docker 容器中的任务
• shell: 用于运行本地的 shell 任务
• build: 用于构建相关任务
• deploy: 用于部署相关任务

项目结构建议

为了让 CI/CD 流水线正常工作，建议项目结构如下：

your-project/
├── .gitlab-ci.yml          # CI/CD 配置文件
├── package.json            # Node.js 项目配置
├── requirements.txt        # Python 依赖文件
├── Dockerfile             # Docker 构建文件
├── tests/                 # 测试文件目录
│   ├── unit/
│   └── integration/
├── src/                   # 源代码目录
└── docs/                  # 文档目录

自定义配置

修改构建镜像

build-app:
  image: your-custom-build-image:latest  # 替换为你的构建镜像

修改测试命令

unit-tests:
  script:
    - npm run test:unit        # 替换为你的测试命令

添加自定义阶段

stages:
  - lint
  - test
  - security
  - build
  - deploy
  - notify  # 新增通知阶段

故障排除

常见问题

1. Runner 未找到

   • 确保 GitLab Runner 正在运行
   • 检查 Runner 标签是否匹配

2. Docker 构建失败

   • 检查 Dockerfile 是否存在
   • 确认 Docker 服务正常运行

3. 测试失败

   • 检查依赖是否正确安装
   • 确认测试命令是否正确

4. 权限问题

   • 检查 SSH 密钥配置
   • 确认部署脚本权限

调试技巧

1. 启用调试模式

   variables:
     CI_DEBUG_TRACE: "true"
   

2. 查看详细日志

   • 在 GitLab UI 中查看流水线日志
   • 使用 docker logs 查看 Runner 日志

3. 本地测试

   # 本地运行 GitLab Runner
   gitlab-runner exec docker test
   

更多资源

• GitLab CI/CD 官方文档
• GitLab Runner 配置
• Docker 构建