hugocombe/php-diagram

PHP Diagram GitLab CI 镜像文档

镜像概述

本镜像为针对GitLab CI/CD环境优化的PHP专用镜像，旨在提供开箱即用的图表生成能力，支持在持续集成流程中自动化完成各类图表（如流程图、架构图、时序图等）的渲染与输出，简化技术文档自动化流程。

核心功能与特性

核心能力

• 预装图表生成所需PHP依赖库（如diagrams-php、graphviz扩展等）
• 集成GitLab CI环境适配逻辑，支持CI流水线中的文件输入输出与产物管理
• 支持多格式图表渲染（PNG、SVG、PDF等）

关键特性

• 轻量级设计：基于Alpine Linux构建，镜像体积小，加速CI环境拉取速度
• 兼容性强：支持PHP 7.4+版本，适配主流GitLab Runner环境
• 灵活配置：通过环境变量或命令行参数自定义图表类型、输出路径及样式
• 无状态运行：支持一次性任务执行，符合CI/CD流水线临时容器特性

使用场景与适用范围

典型场景

• GitLab CI流水线中的技术文档自动化（如架构图嵌入API文档）
• 代码库中图表源文件（如.diagram、.puml）的自动渲染
• 项目发布流程中的版本变更图表生成
• 自动化测试报告中的可视化结果输出

适用对象

• 开发团队：实现代码与图表源文件的版本控制及自动渲染
• DevOps团队：简化CI/CD流水线中图表生成环节的配置
• 技术文档团队：构建文档即代码（Docs as Code）工作流

使用方法与配置说明

GitLab CI 集成示例

在.gitlab-ci.yml中定义图表生成任务：

yaml
stages:
  - generate_diagram

generate_architecture_diagram:
  stage: generate_diagram
  image: [镜像名称]  # 替换为实际镜像名称
  script:
    - php /usr/local/bin/diagram-generator.php 
      --input=docs/architecture.diagram 
      --output=public/architecture.png 
      --format=png
  artifacts:
    paths:
      - public/architecture.png  # 存储生成的图表作为流水线产物
    expire_in: 1 week  # 设置产物过期时间

本地测试命令

使用docker run命令本地验证图表生成：

bash
# 挂载当前目录到容器/app，生成图表并输出到本地
docker run --rm -v $(pwd):/app [镜像名称] \
  php /usr/local/bin/diagram-generator.php \
  --input=/app/sample.diagram \
  --output=/app/output.png \
  --format=png

配置参数说明

命令行参数

环境变量

注意事项

1. 确保GitLab Runner配置支持Docker镜像拉取（需开启privileged模式或配置镜像仓库访问权限）
2. 图表源文件建议与代码一同版本控制，确保CI流程可追溯
3. 大型图表渲染可能需要调整Runner资源限制（如内存、CPU）
4. 输出文件需通过GitLab CI artifacts配置持久化，以便后续流程（如部署、下载）访问