Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
image

GitHub Action

Generate Plantuml

v1.0

Generate Plantuml

image

Generate Plantuml

Generate uml diagrams with Plantuml Server and push them to your repository

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Generate Plantuml

uses: grassedge/[email protected]

Learn more about this action in grassedge/generate-plantuml-action

Choose a version

generate-plantuml-action

Generate uml diagrams with Plantuml Server and push them to your repository.

This action ease you to maintain UML. UML is very useful, but there are some difficulties to maintain. PlantUML enables you to write UML with text code, that is engineer-friendly so you would like it.

This actions generate UML diagrams from plantuml code with PlantUML Server when you commit .pu file or .md file that plantuml code is written on.

Usage

This Action subscribes to Push events.

name: generate plantuml
on: push
jobs:
  generate_plantuml:
    runs-on: ubuntu-latest
    name: plantuml
    steps:
    - name: checkout
      uses: actions/checkout@v1
      with:
        fetch-depth: 20
    - name: plantuml
      id: plantuml
      uses: grassedge/generate-plantuml-action@v1.0
      with:
        path: example
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

input

  • path : required specify the path to save generated svg files.

env

  • GITHUB_TOKEN : required GitHub Token of your repository to commit svg files.

Note: fetch-depth on checkout should be more than a certain number because this action detects updated files with following command git diff --name-only.

Demo

see examples here.

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.