modigie/modigie-local

Modigie构建镜像文档

镜像概述

Modigie构建镜像是一个标准化的应用构建环境，旨在统一开发与部署过程中的构建环节，解决因环境差异导致的"在我机器上能运行"问题。该镜像集成了常用构建工具链，提供隔离且一致的构建环境，适用于各类应用程序的编译、打包及预处理流程。

核心功能与特性

• 标准化环境：预配置常用构建工具，确保不同环境下的构建结果一致
• 工具集成：内置编译器、打包工具、依赖管理工具等构建必需组件
• 环境隔离：基于Docker容器技术，构建过程与主机环境完全隔离，避免依赖冲突
• 轻量级设计：优化镜像体积，减少资源占用，提升构建效率
• 可扩展性：支持通过环境变量或配置文件自定义构建参数和流程

使用场景

• 开发团队协作：统一团队成员的本地构建环境，消除环境差异导致的构建问题
• CI/CD流水线：集成到持续集成/持续部署系统（如Jenkins、GitLab CI等），自动化构建流程
• 跨平台构建：支持在单一环境中构建适用于不同目标平台的应用程序包
• 版本发布管理：用于稳定版本的编译打包，确保发布包的一致性

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动构建环境，挂载本地代码目录并执行构建命令：

bash
docker run -it --rm \
  -v /path/to/your/project:/app \
  -w /app \
  modigie/build-image:latest \
  <构建命令>

参数说明：

• -v /path/to/your/project:/app：将本地项目目录挂载到容器内的/app工作目录
• -w /app：设置容器工作目录为/app
• <构建命令>：替换为实际构建命令（如make build、npm run build等）

环境变量配置

该镜像支持通过环境变量自定义构建行为，常用环境变量如下：

示例：指定构建目标为linux/arm64并开启调试日志

bash
docker run -it --rm \
  -v /path/to/your/project:/app \
  -w /app \
  -e BUILD_TARGET=linux/arm64 \
  -e LOG_LEVEL=debug \
  modigie/build-image:latest \
  npm run build

自定义配置文件

如需更复杂的构建配置，可在项目根目录下创建.modigie-build.yaml配置文件，镜像将自动读取并应用配置。配置文件示例：

yaml
build:
  steps:
    - name: "依赖安装"
      command: "npm install"
    - name: "代码检查"
      command: "npm run lint"
    - name: "编译构建"
      command: "npm run build"
output:
  dir: "/app/custom-dist"
  preserve: true  # 保留构建过程中的临时文件

注意事项

• 确保本地项目目录拥有适当的读写权限，避免挂载目录权限问题
• 对于大型项目，建议增加容器内存限制（--memory参数）以避免构建过程中内存不足
• 如需持久化构建缓存，可额外挂载缓存目录（如-v /path/to/cache:/root/.cache）

版本信息

• 最新稳定版：modigie/build-image:latest
• 版本历史及更新日志请参考Modigie官方仓库文档