bondvet/circle-ci

docker-circle-ci 镜像文档

镜像概述

docker-circle-ci 是专为 CircleCI 持续集成平台设计的 Docker 镜像，旨在为 CI/CD 流程中的构建阶段提供一致、可靠的运行环境。该镜像预配置了常见构建工具，可无缝集成 CircleCI 工作流，确保开发团队在自动化构建过程中获得稳定且可重复的构建结果。

核心功能与特性

• CircleCI 无缝集成：针对 CircleCI 平台特性优化，支持通过 CircleCI 配置文件（如 .circleci/config.yml）直接调用
• 预配置构建环境：内置常用构建工具（如编译器、打包工具、测试框架等），减少环境配置时间
• 多场景支持：适用于代码编译、单元测试执行、应用打包等多种构建场景
• 轻量级设计：基于精简基础镜像构建，减少资源占用，提升构建效率
• 环境一致性：确保不同开发环境与 CI 环境的构建结果一致，避免"在我机器上能运行"问题

使用场景与适用范围

• CI/CD 构建阶段：在 CircleCI 流水线中执行代码编译、静态分析、单元测试等构建任务
• 跨平台构建：为不同项目（如前端、后端、移动应用）提供统一的构建环境
• 自动化打包：用于在 CI 流程中打包应用程序（如生成 Docker 镜像、可执行文件、安装包等）
• 团队协作：适用于需要统一构建标准的开发团队，确保所有成员使用一致的构建工具链

使用方法与配置说明

基本使用（docker run 命令）

通过以下命令在本地模拟 CircleCI 构建环境（实际使用中通常在 CircleCI 平台配置调用）：

bash
docker run --rm -v $(pwd):/app docker-circle-ci:latest \
  sh -c "cd /app && npm install && npm run build"

参数说明：

• -v $(pwd):/app：将本地项目目录挂载到容器内 /app 目录
• sh -c "..."：执行构建命令（根据项目需求替换为实际构建步骤，如 mvn package、yarn build 等）

与 CircleCI 集成配置

在 .circleci/config.yml 中使用该镜像作为构建环境：

yaml
version: 2.1
jobs:
  build:
    docker:
      - image: docker-circle-ci:latest
    steps:
      - checkout
      - run: npm install
      - run: npm run test
      - run: npm run build
workflows:
  build-and-test:
    jobs:
      - build

环境变量

该镜像支持通过环境变量自定义构建行为，常见变量包括：

docker-compose 配置示例

如需本地复现完整构建流程，可使用 docker-compose.yml：

yaml
version: '3'
services:
  circleci-build:
    image: docker-circle-ci:latest
    volumes:
      - ./:/app
      - build-cache:/app/node_modules  # 挂载缓存目录
    environment:
      - BUILD_DIR=/app
      - LOG_LEVEL=debug
    command: sh -c "npm install && npm run build && npm run test"

volumes:
  build-cache:  # 持久化构建缓存，加速后续构建

注意事项

• 该镜像需配合 CircleCI 平台使用以发挥最佳效果，本地运行仅用于环境调试
• 根据项目需求，可能需要在镜像基础上自定义安装额外依赖（可通过 Dockerfile 基于此镜像扩展）
• 启用构建缓存可显著提升重复构建效率，建议在 CircleCI 配置中结合缓存策略使用