bmdconsulting/spork-builder

SPORK Builder镜像文档

概述

SPORK Builder镜像是专为SPORK项目设计的构建工具镜像，旨在提供统一、可移植的构建环境。通过预集成SPORK项目所需的构建工具、依赖库及配置，该镜像可消除因开发环境差异导致的构建问题，简化SPORK应用的编译与打包流程，适用于开发、测试及CI/CD场景。

核心功能与特性

• 统一构建环境：预安装SPORK项目构建所需的编译器、打包工具及依赖组件，确保跨环境构建一致性。
• 依赖管理：内置依赖解析工具，自动处理SPORK项目的依赖下载与版本控制，减少手动配置工作。
• 多阶段构建支持：支持Docker多阶段构建，可作为构建阶段镜像，仅将最终产物复制到应用镜像，减少目标镜像体积。
• 兼容性保障：针对SPORK项目特性优化，确保与主流SPORK版本及构建流程兼容。
• 轻量级设计：基于精简基础镜像构建，平衡功能完整性与镜像体积，提升构建效率。

使用场景

• 本地开发构建：开发者无需在本地配置复杂构建环境，直接通过镜像完成SPORK应用的编译与打包。
• CI/CD流程集成：作为CI/CD流水线的构建环节，提供标准化构建步骤，确保自动化构建稳定性。
• 团队协作：统一团队成员的构建环境，避免因本地环境差异导致的"在我电脑上能运行"问题。
• 多版本项目构建：通过指定不同标签的镜像，支持不同版本SPORK项目的构建需求。

使用方法

基本构建命令

通过docker run命令启动镜像，挂载项目目录并执行构建操作：

bash
docker run -v $(pwd):/app -w /app docker.xuanyuan.run/spork-builder:latest sh -c "spork-build --target=production"

参数说明：

• -v $(pwd):/app：将本地SPORK项目根目录挂载至容器内/app目录
• -w /app：设置容器工作目录为/app（项目根目录）
• spork-build --target=production：执行SPORK构建命令，指定生产环境目标

Docker Compose配置

在docker-compose.yml中集成SPORK Builder，简化本地构建流程：

yaml
version: '3.8'
services:
  spork-builder:
    image: docker.xuanyuan.run/spork-builder:latest
    volumes:
      - ./:/app  # 挂载本地项目目录
    working_dir: /app
    command: ["spork-build", "--target=development"]  # 开发环境构建命令
    environment:
      - SPORK_BUILD_OUTPUT=/app/dist  # 构建产物输出目录
      - SPORK_DEBUG=0  # 关闭调试模式

执行构建：

bash
docker-compose run spork-builder

环境变量配置

SPORK Builder支持以下环境变量自定义构建行为：

多阶段构建示例

在Dockerfile中使用SPORK Builder作为构建阶段，生成轻量级应用镜像：

dockerfile
# 构建阶段：使用SPORK Builder编译项目
FROM docker.xuanyuan.run/spork-builder:latest AS builder
WORKDIR /app
COPY . .  # 复制项目源码
RUN spork-build --target=production  # 执行生产环境构建

# 应用阶段：构建轻量级运行时镜像
FROM docker.xuanyuan.run/alpine:latest
COPY --from=builder /app/build /app  # 仅复制构建产物
WORKDIR /app
CMD ["./spork-app"]  # 启动SPORK应用

注意事项

• 挂载项目目录时，确保本地用户权限与容器内用户权限匹配，避免文件读写权限问题。
• 大型项目建议配置构建缓存（通过SPORK_CACHE_DIR）以提升重复构建效率。
• 不同版本的SPORK Builder镜像可能对应不同SPORK项目版本，使用时需确认镜像标签与项目版本兼容性。