sofaframework/sofabuilder_ubuntu

SOFA Continuous Integration Configuration 镜像文档

镜像概述

SOFA Continuous Integration Configuration镜像专为SOFA生态项目设计，提供持续集成(CI)流程的标准化配置环境。该镜像集成SOFA生态工具链，支持自动化构建、代码检查、单元测试、集成测试及部署流程的配置管理，旨在简化SOFA应用从开发到交付的全流程自动化。

核心功能与特性

• SOFA生态集成：预置SOFAStack相关工具（如SOFA-Boot、SOFA-RPC等）的CI适配配置，无缝对接SOFA项目开发流程。
• 自动化流程支持：内置CI流程模板，支持代码拉取、依赖安装、构建、测试（单元/集成）、制品打包等自动化步骤。
• 配置管理：提供灵活的配置文件挂载机制，支持自定义CI流程参数（如测试报告路径、构建产物输出目录等）。
• 多环境适配：兼容主流CI平台（Jenkins、GitLab CI、GitHub Actions等），支持不同环境下的CI流程一致性。

使用场景与适用范围

• SOFA微服务项目的CI/CD流程搭建与标准化。
• 需要快速部署SOFA应用持续集成环境的开发团队。
• 对SOFA项目进行自动化测试、构建及版本发布的场景。

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name sofa-ci-config \
  -v /path/to/sofa-project:/app \
  -v /path/to/custom-ci-config:/config \
  -e SOFA_PROJECT_TYPE="sofa-boot" \
  -e CI_STAGE="test" \
  sofa/ci-config:latest

环境变量配置

配置文件说明

镜像支持通过挂载自定义CI配置文件（如ci.yml）调整流程细节，配置文件示例：

yaml
# /config/ci.yml 示例
stages:
  - build:
      commands:
        - mvn clean package -DskipTests
  - test:
      commands:
        - mvn test
      report_path: "${TEST_REPORT_OUTPUT}/junit.xml"
  - deploy:
      commands:
        - mvn deploy -Dmaven.test.skip=true

Docker Compose配置示例

yaml
version: '3'
services:
  sofa-ci:
    image: sofa/ci-config:latest
    volumes:
      - ./sofa-project:/app
      - ./ci-config:/config
    environment:
      - SOFA_PROJECT_TYPE=sofa-boot
      - CI_STAGE=test
      - TEST_REPORT_OUTPUT=/app/reports

注意事项

• 确保挂载的项目源码路径包含SOFA项目标准结构（如pom.xml、src/main等）。
• 自定义配置文件需遵循镜像支持的YAML格式规范，否则可能导致流程执行异常。
• 不同SOFA项目类型（如SOFA-Boot、SOFA-RPC）可能需要调整SOFA_PROJECT_TYPE参数以启用对应工具链。