oarteam/batsim_ci

Batsim 持续集成环境镜像文档

镜像概述

Batsim持续集成环境镜像是一个集成化的Docker镜像，专为开发团队提供一站式的自动化构建、测试及文档生成解决方案。该镜像封装了必要的构建工具、测试框架及文档生成器，可无缝集成至CI/CD流程，简化开发团队的自动化流程配置。

核心功能与特性

• 自动化构建：支持主流编程语言项目的源代码编译与打包，兼容Make、Maven、Gradle等构建工具
• 自动化测试：集成单元测试、集成测试及性能测试能力，支持JUnit、PyTest等主流测试框架
• 文档生成：内置文档生成工具，可自动从代码注释或Markdown源文件生成HTML、PDF等格式的项目文档
• 轻量级设计：基于精简基础镜像构建，减少资源占用，提升CI流程执行效率

使用场景与适用范围

• 开发团队的持续集成（CI）流程自动化
• 项目构建、测试、文档生成的一体化流程管理
• 开源项目或企业内部项目的自动化质量管控
• 多语言项目的统一CI环境配置

使用方法与配置说明

基本使用命令

通过以下命令启动容器并执行CI流程：

bash
docker run -v $(pwd):/workspace batsim-ci:latest

说明：默认将当前目录挂载至容器内/workspace工作目录，自动执行构建→测试→文档生成全流程

环境变量配置

支持通过环境变量自定义CI流程行为：

高级使用示例

1. 指定自定义构建与测试命令

bash
docker run -v $(pwd):/workspace \
  -e BUILD_CMD="npm run build" \
  -e TEST_CMD="npm run test:coverage" \
  batsim-ci:latest

2. 仅执行文档生成任务

bash
docker run -v $(pwd):/workspace \
  -e BUILD_CMD="" \
  -e TEST_CMD="" \
  -e DOC_CMD="sphinx-build -b html docs/source docs/build" \
  batsim-ci:latest

数据持久化

容器执行完成后，构建产物、测试报告及生成的文档默认保存在挂载目录的output子目录中，可通过以下方式访问：

bash
# 查看构建产物
ls $(pwd)/output/build

# 查看测试报告
ls $(pwd)/output/test-reports

# 查看生成的文档
ls $(pwd)/output/docs

集成至CI/CD平台

在GitLab CI、GitHub Actions等平台中使用时，可通过配置文件集成：

yaml
# .gitlab-ci.yml示例
stages:
  - ci-pipeline

batsim-ci-job:
  stage: ci-pipeline
  image: batsim-ci:latest
  script:
    - /entrypoint.sh  # 执行默认CI流程
  artifacts:
    paths:
      - output/  # 保存CI产物