README.md

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: abekoh/commit-plantuml-action@1.0.3
        with:
          botEmail: ${{ secrets.BOT_EMAIL }}
          botGithubToken: ${{ secrets.GITHUB_TOKEN }}
          enableReviewComment: true

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.