使用 GitHub Actions 自动生成 PlantUML 图表
2025-05-21 21:25:38作者:贡沫苏Truman
generate-plantuml-action
Generate uml diagrams with Plantuml Server and push them to your repository.
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 图表的生成保持最新,并且与代码库同步更新。
热门项目推荐
相关项目推荐
- DDeepSeek-R1-0528DeepSeek-R1-0528 是 DeepSeek R1 系列的小版本升级,通过增加计算资源和后训练算法优化,显著提升推理深度与推理能力,整体性能接近行业领先模型(如 O3、Gemini 2.5 Pro)Python00
cherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端TSX028unibest
unibest - 最好用的 uniapp 开发框架。unibest 是由 uniapp + Vue3 + Ts + Vite5 + UnoCss + WotUI 驱动的跨端快速启动模板,使用 VS Code 开发,具有代码提示、自动格式化、统一配置、代码片段等功能,同时内置了大量平时开发常用的基本组件,开箱即用,让你编写 uniapp 拥有 best 体验。TypeScript00
热门内容推荐
1 freeCodeCamp博客页面工作坊中的断言方法优化建议2 freeCodeCamp 前端开发实验室:排列生成器代码规范优化3 freeCodeCamp全栈开发课程中测验游戏项目的参数顺序问题解析4 freeCodeCamp英语课程中反馈文本的优化建议5 freeCodeCamp React课程模块加载问题解析6 freeCodeCamp Python密码生成器课程中的动词一致性修正7 freeCodeCamp城市天际线项目中CSS代码优化的关键步骤8 freeCodeCamp课程中Todo应用测试用例的优化建议9 freeCodeCamp音乐播放器项目中的函数调用问题解析10 freeCodeCamp博客页面开发中锚点跳转问题的技术解析
最新内容推荐
项目优选
收起

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
414
315

React Native鸿蒙化仓库
C++
90
155

openGauss kernel ~ openGauss is an open source relational database management system
C++
45
112

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
268
399

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
50
13

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TSX
302
28

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
341
209

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
84
60

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
625
72

轻量级、语义化、对开发者友好的 golang 时间处理库
Go
7
2