Open-Transactions CI Docker镜像文档

镜像概述和主要用途

本镜像为Open-Transactions项目专用的持续集成（CI）环境镜像，基于Ubuntu/Debian基础镜像构建，集成了项目CI流程所需的编译器、构建工具、依赖库及测试框架。主要用途是为Open-Transactions项目的自动化构建、单元测试、集成测试等CI流程提供一致、可复现的运行环境，消除因环境差异导致的构建或测试异常。

核心功能和特性

• 预配置构建环境：内置GCC、Clang等编译器，CMake、Make等构建工具，以及项目依赖的基础库（如Boost、Protobuf等），无需手动安装依赖。
• 标准化CI流程：统一开发团队与CI平台（如GitHub Actions、GitLab CI）的运行环境，确保本地开发与远程CI结果一致性。
• 轻量级设计：在满足CI需求的前提下优化镜像体积，缩短拉取时间和存储空间占用。
• 多阶段支持：兼容多阶段构建流程，可按需执行代码编译、静态分析、测试等不同CI阶段任务。

使用场景和适用范围

适用场景

• Open-Transactions项目的自动化构建流程（如每日构建、提交触发构建）。
• 项目单元测试、集成测试的自动化执行。
• 开发者本地复现CI环境中的构建或测试问题。
• 第三方扩展或插件基于Open-Transactions的CI流程集成。

适用范围

• Open-Transactions项目开发团队
• 参与Open-Transactions贡献的外部开发者
• 基于Open-Transactions构建应用的项目CI流程

使用方法和配置说明

基本使用

拉取镜像

bash
docker pull opentransactions/ci:latest

运行容器（基础构建流程）

bash
# 挂载本地项目目录至容器内，执行构建命令
docker run --rm -v $(pwd):/workspace opentransactions/ci:latest \
  /bin/bash -c "cd /workspace && cmake -B build && cmake --build build"

运行测试流程

bash
# 在容器内执行项目测试用例
docker run --rm -v $(pwd):/workspace opentransactions/ci:latest \
  /bin/bash -c "cd /workspace/build && ctest --output-on-failure"

环境变量配置

示例：指定Debug构建并过滤测试用例

bash
docker run --rm -v $(pwd):/workspace \
  -e BUILD_TYPE=Debug \
  -e TEST_FILTER=*UnitTest* \
  opentransactions/ci:latest \
  /bin/bash -c "cd /workspace && cmake -B build -DCMAKE_BUILD_TYPE=\$BUILD_TYPE && cmake --build build && cd build && ctest -R \$TEST_FILTER"

Docker Compose示例

创建 docker-compose.ci.yml 文件：

yaml
version: '3'
services:
  ci:
    image: opentransactions/ci:latest
    volumes:
      - ./:/workspace
    environment:
      - BUILD_TYPE=Release
      - CC=/usr/bin/gcc
      - CXX=/usr/bin/g++
    command: /bin/bash -c "cd /workspace && cmake -B build && cmake --build build && cd build && ctest"

运行命令：

bash
docker-compose -f docker-compose.ci.yml up

注意事项

• 镜像标签：latest 对应项目主分支最新环境，建议生产CI流程使用固定版本标签（如 v2.1.0）以确保稳定性。
• 本地目录权限：挂载主机目录时需确保容器内用户（默认root）对挂载目录有读写权限，避免因权限问题导致构建失败。
• 依赖更新：若项目依赖发生变化，需同步更新镜像或通过容器内命令手动升级依赖。