generate-plantuml-action 的安装和配置教程

2025-05-21 11:40:20作者：卓炯娓

项目基础介绍

generate-plantuml-action 是一个开源项目，它能够帮助你使用 PlantUML Server 生成 UML 图表，并将这些图表保存回你的 Git 仓库中。这个项目主要是为了让维护 UML 图表变得更加简单。UML 图表对于软件开发来说非常有用，但是维护它们可能会有些困难。generate-plantuml-action 利用文本代码编写 UML，使得这个过程对工程师更加友好。

该项目主要使用的编程语言是 TypeScript 和 JavaScript。

项目使用的关键技术和框架

PlantUML：用于创建 UML 图表的工具，它允许用户通过文本代码来定义图表。
GitHub Actions：用于自动化你仓库的工作流程，例如在这个案例中，自动化生成和提交 UML 图表。

准备工作

在开始安装和配置 generate-plantuml-action 之前，请确保你已经满足以下条件：

你有一个 GitHub 账户，并且已经创建了一个仓库。
你熟悉 Git 命令行的基本使用。
你的计算机上安装了 Node.js 环境。

安装步骤

以下是安装和配置 generate-plantuml-action 的详细步骤：

克隆你的仓库：

首先，需要将你的 GitHub 仓库克隆到本地环境中。打开命令行工具，执行以下命令：
```
git clone <你的仓库地址>
cd <仓库名>
```

添加 GitHub Action 工作流文件：

在你的项目根目录下，创建一个新的 .github/workflows 文件夹，并在该文件夹中创建一个 YAML 文件，例如 generate_plantuml.yml。这个文件将定义你的工作流程。

name: Generate PlantUML

on: [push]

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: ./path/to/your/plantuml/files
          message: "Generate PlantUML diagrams"
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

在这个 YAML 文件中，你需要根据自己的需求修改 path 字段，以指定 PlantUML 文件的位置。

配置 GitHub Secrets：

为了让 GitHub Action 能够提交更改到你的仓库，你需要在仓库的 Settings -> Secrets 中添加一个新的 secret，命名为 GITHUB_TOKEN。
提交更改：

将 .github/workflows 文件夹添加到你的仓库中，并提交这些更改。
```
git add .github/workflows/generate_plantuml.yml
git commit -m "Add GitHub Action to generate PlantUML diagrams"
git push origin main
```
请确保将 main 替换为你的默认分支名。