https://github.com/grassedge/generate-plantuml-action

Generate uml diagrams with Plantuml Server and push them to your repository.
https://github.com/grassedge/generate-plantuml-action

github-actions plantuml uml-diagrams

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/grassedge/generate-plantuml-action
• Owner: grassedge
• License: mit
• Created: 2019-12-08T06:53:26.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T04:55:06.000Z (5 months ago)
• Last Synced: 2024-11-04T15:03:19.488Z (14 days ago)
• Topics: github-actions, plantuml, uml-diagrams
• Language: TypeScript
• Size: 902 KB
• Stars: 107
• Watchers: 1
• Forks: 169
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Maintainability](https://api.codeclimate.com/v1/badges/a21c7671c0a7ae182c28/maintainability)](https://codeclimate.com/github/grassedge/generate-plantuml-action/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/a21c7671c0a7ae182c28/test_coverage)](https://codeclimate.com/github/grassedge/generate-plantuml-action/test_coverage)

[![Actions Status](https://github.com/grassedge/generate-plantuml-action/workflows/tests/badge.svg)](https://github.com/grassedge/generate-plantuml-action/actions)

# 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](https://plantuml.com/) 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](https://plantuml.com/en/server) when you commit plantUML files

or Markdown files that plantuml code is written in.

PlantUML files must end in either of

- `.pu`

- `.pml`

- `.puml`

- `.plantuml`

Markdown files must end in

- `.md`

- `.markdown`

- `.mdown`

- `.mkdn`

- `.mdwn`

- `.mkd`

- `.mdn`

- `.md.txt`

## Usage

This Action subscribes to Push events.

```workflow

name: generate plantuml

on: push

jobs:

  generate_plantuml:

    runs-on: ubuntu-latest

    name: plantuml

    steps:

    - name: checkout

      uses: actions/checkout@v1

      with:

        fetch-depth: 1

    - name: plantuml

      id: plantuml

      uses: grassedge/[email protected]

      with:

        path: example

        message: "Render PlantUML files"

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

*input*

- `path` : specify the path to save generated svg files  

  the default (`.`) saves each SVG file in the same folder as the source

  file it was generated from

- `message` : specify the commit message for the commit of generated

  svg files (defaults to `Render PlantUML files`)

*env*

- `GITHUB_TOKEN` : *required* GitHub Token of your repository to commit svg files.

## Demo

see [examples](./example/sample.md) here.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).