Generate and Commit PlantUML Diagrams

This action generate diagrams (png) from PlantUML files (*.puml), and commit to pull-request. Also this can add review comment of diff files.

See sample pull request

Usage

example:

jobs:
  build:
    steps:
      - uses: actions/checkout@v2
      - name: generate and commit diagrams
        uses: zaphiro-technologies/commit-plantuml-action@1.0.4
        with:
          botEmail: ${{ secrets.BOT_EMAIL }}
          botGithubToken: ${{ secrets.GITHUB_TOKEN }}
          enableReviewComment: true
          installGoogleFont: Barlow:100,100i,200,200i,300,300i,400,400i,500,500i,600,600i,700,700i,800,800i,900,900i
          javaArgs: -DPLANTUML_LIMIT_SIZE=8192

You must set actions/checkout before this step, to get source codes.

Inputs

botEmail

required: true

E-mail address for committing to git. You can use secrets.

botGithubToken

required: false

To add review comment. Use default secrets.GITHUB_TOKEN, or generate from here. (Select repo as scope.)

enableReviewComment

required: false, default: false

If set true, diff png files' information are submitted to pull request.

installGoogleFont

required: false

If set, the value will be use to download and install a font family from google. To be used in combination with skinparam defaultFontName and other FontName skin settings for plantuml.

javaArgs

required: false

Java arguments passed to plantuml jar.