This action runs the PlantUML tool to generate images from PlantUML text diagrams.
Required The arguments for PlantUML tool. Default "-h".
This is an an example of a workflow which generates the svg and png images from PlantUML text digram. It will
trigger every time there is a change in a puml file.
.github/worksflows/main.yml:
name: Generate PlantUML Diagrams
on:
push:
paths:
- '**.puml'
branches:
- master
jobs:
ci:
runs-on: ubuntu-latest
env:
UML_FILES: ".puml"
steps:
- name: Checkout Source
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get changed UML files
id: getfile
run: |
echo "::set-output name=files::$(git diff-tree -r --no-commit-id --name-only ${{ github.sha }} | grep ${{ env.UML_FILES }} | xargs)"
- name: UML files considered echo output
run: |
echo ${{ steps.getfile.outputs.files }}
- name: Generate SVG Diagrams
uses: cloudbees/plantuml-github-action@master
with:
args: -v -tsvg ${{ steps.getfile.outputs.files }}
- name: Generate PNG Diagrams
uses: cloudbees/plantuml-github-action@master
with:
args: -v -tpng ${{ steps.getfile.outputs.files }}
- name: Push Local Changes
uses: stefanzweifel/git-auto-commit-action@v4.1.2
with:
commit_user_name: "my user name"
commit_user_email: "me@email.org"
commit_author: "My User <me@email.org>"
commit_message: "Generate SVG and PNG images for PlantUML diagrams"
branch: ${{ github.head_ref }}The last step will commit the generated images back into the master branch.