使用 GitHub Actions 自动生成 PlantUML 图表

1. 项目介绍

generate-plantuml-action 是一个开源项目，它利用 GitHub Actions 自动化地根据 PlantUML 代码生成 UML 图表，并将生成的 SVG 文件推送到你的代码仓库中。PlantUML 是一种易于使用的工具，允许开发者使用简单的文本代码来创建 UML 图表，非常适合工程师的日常使用。

2. 项目快速启动

要快速启动这个项目，你需要遵循以下步骤：

首先，在你的 GitHub 仓库中创建一个新的 .github/workflows 目录（如果尚不存在）。

然后，在该目录中创建一个新的 YAML 文件，例如 generate_plantuml.yml，并添加以下内容：

name: Generate PlantUML

on:
  push:
    paths:
      - '**/*.puml'
      - '**/*.plantuml'
      - '**/*.md'

jobs:
  generate_plantuml:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v1
        with:
          fetch-depth: 1

      - name: PlantUML
        id: plantuml
        uses: grassedge/generate-plantuml-action@v1
        with:
          path: ./ diagrams
          message: 'Render PlantUML files'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这个配置会在每次推送包含 .puml、.plantuml 或 .md 文件时触发工作流，生成相应的 UML 图表，并将它们保存在仓库的 diagrams 目录下。

确保你的仓库设置了 GITHUB_TOKEN，这是必需的，以便 GitHub Actions 有权限在仓库中创建和提交文件。

3. 应用案例和最佳实践

应用案例

• 文档生成：在你的项目文档中嵌入 UML 图表，以提供直观的示例和流程图。
• 设计评审：在代码审查过程中使用 UML 图表来讨论和评审软件设计。

最佳实践

• 代码组织：保持 PlantUML 文件的组织结构清晰，按照功能或模块进行分类。
• 分支管理：在特性分支上生成 UML 图表，合并到主分支前确保图表正确无误。

4. 典型生态项目

在开源生态中，许多项目已经采用自动化的 UML 生成来改善文档和设计过程。例如，一些框架或库的项目可能会使用 PlantUML 来生成 API 文档中的序列图或类图，这样可以帮助开发者更好地理解和使用这些库。

通过集成 generate-plantuml-action，这些项目可以确保 UML 图表的生成保持最新，并且与代码库同步更新。