GitHub Action
PlantUML End-to-End Action
v0.2.1
Latest version
A GitHub Action for creating a PlantUML file from a Python module and exporting it as an image.
This repository was forked from this repo and extends it by automating the end-to-end process, from generating the PlantUML diagram based on Python modules to exporting that diagram as SVG for ease of access and in-repo rendering.
Use it from the GitHub Actions marketplace.
The following workflow generates a PlantUML diagram from the Python module tests
in the tests directory and exports it as PUML file as well as SVG to the diagrams directory.
Subsequently, the changed files are committed and pushed to the repository.
name: My workflow
on:
push:
branches: [ "main" ]
jobs:
generate_diagram:
name: Generate PlantUML diagram
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.ref }}
- name: Build & render diagram
uses: stiebels/plantuml-e2e-action@main
with:
puml_version: "1.2023.7"
pip_install_deps_cmd: "pip install -r tests/requirements.txt"
path: "tests"
module: "tests"
output_dir: "diagrams"
- name: Commit changed files
run: |
git config user.email gh-actions
git config user.name gh-actions
git add .
git commit -m "Committed updated class diagram"
git push- See here for a list of eligible versions to pass to
puml_version. - See here for a clear explanation on
pathandmodule, following the definition ofpy2puml.
puml_version:
description: PlantUML software version. Whereas it defaults to "latest", it's recommended to pin down the PlantUML version.
default: "latest"
required: true
pip_install_deps_cmd:
description: The command that installs your project's dependencies require to have py2puml import your project. Typically, that'd be e.g. `pip install .` or `pip install .[docs]`. If the command doesn't install a version of `py2puml`, the latest version will be auto-installed.
required: true
path:
description: the filepath to the domain following the py2puml definition
required: true
module:
description: the module name of the domain following the py2puml definition
required: true
output_dir:
description: the directory where the SVG should be saved to. File names default to the module name, but differ by file extension (.puml/.svg).
default: diagrams
required: true