playbrain/ci

CI 环境 Docker 镜像文档

概述

本Docker镜像提供完整的持续集成（CI）环境，旨在简化开发团队的自动化构建、测试和部署流程。通过容器化方式封装CI所需的核心工具与依赖，确保开发、测试与生产环境的一致性，降低环境配置复杂度，提升集成效率。

核心功能与特性

• 多工具支持：集成常见构建工具（如Maven、Gradle、npm）、测试框架（JUnit、PyTest、Jest）及版本控制工具（Git）。
• 环境一致性：容器化封装确保所有团队成员使用相同的CI环境，避免"本地可运行，CI失败"的环境差异问题。
• 可定制配置：支持通过环境变量、配置文件或挂载卷自定义构建流程、测试参数及部署目标。
• 轻量级设计：基于Alpine或Debian slim基础镜像，减小镜像体积，加快启动速度。
• 日志集成：支持将构建、测试日志输出至标准流或外部日志系统（如ELK、Prometheus）。

使用场景

• 开发团队日常集成：自动化执行代码提交后的构建、单元测试、代码质量检查（如SonarQube）。
• 多环境部署验证：在预发布环境中自动运行集成测试，验证部署包可用性。
• 开源项目自动化流程：为开源项目提供标准化CI环境，支持GitHub/GitLab等平台的WebHook触发。
• 跨平台构建：通过配置多架构支持，实现同一CI流程在不同硬件平台（如x86、ARM）的构建验证。

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name ci-environment \
  -v /path/to/project:/workspace \  # 挂载项目代码目录
  -e CI_PROJECT_URL="https://github.com/your-org/your-project" \  # 项目仓库URL
  -e CI_BUILD_SCRIPT="/workspace/build.sh" \  # 自定义构建脚本路径
  -e CI_TEST_CMD="pytest tests/" \  # 测试命令
  ci-image:latest

Docker Compose 配置示例

yaml
version: '3'
services:
  ci:
    image: ci-image:latest
    volumes:
      - ./project:/workspace
      - ./ci-config:/etc/ci  # 挂载自定义配置文件
    environment:
      - CI_PROJECT_URL="https://gitlab.com/your-org/your-project"
      - CI_BUILD_SCRIPT="/workspace/mvn clean package"  # Maven构建示例
      - CI_TEST_CMD="npm test"  # Node.js测试示例
      - CI_REPORT_PATH="/workspace/reports"  # 测试报告输出路径
    restart: unless-stopped

核心环境变量配置

自定义配置文件

通过挂载配置文件 /etc/ci/config.yaml 可进一步定制流程，示例配置：

yaml
stages:
  - fetch:  # 拉取代码阶段
      cmd: "git clone ${CI_PROJECT_URL} /workspace"
  - build:  # 构建阶段
      cmd: "${CI_BUILD_SCRIPT}"
      timeout: 1800  # 单独设置构建超时（秒）
  - test:  # 测试阶段
      cmd: "${CI_TEST_CMD}"
      report:  # 报告生成配置
        type: "junit"  # 支持junit、cobertura等格式
        path: "${CI_REPORT_PATH}/test-results.xml"
  - notify:  # 通知阶段（可选）
      cmd: "curl -X POST https://your-webhook.com -d 'status=${CI_STATUS}'"

集成版本控制系统

若需通过WebHook触发CI流程，可结合反向代理（如Nginx）暴露容器端口，并配置WebHook处理：

bash
# 启动容器时映射端口
docker run -d -p 8080:8080 ci-image:latest

# 配置WebHook处理（容器内）
# 在 /etc/ci/webhook.json 中定义触发规则，支持GitHub/GitLab事件格式

注意事项

• 挂载项目目录时，确保宿主目录权限允许容器读写（建议设置权限为755）。
• 敏感信息（如仓库访问令牌、部署密钥）建议通过Docker Secrets或外部密钥管理服务注入，避免明文环境变量。
• 对于长时间运行的CI任务，建议配置健康检查（HEALTHCHECK）监控容器状态。