Skip to content

GitHub Action to generate images from PlantUML files.

License

Notifications You must be signed in to change notification settings

rotaract/plantuml-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

PlantUML GitHub Action

Open Source Rotaract Germany
Maintenance Status

🔎 Overview

Generation of PlantUML diagrams in a GitHub Action using the official plantuml/plantuml Docker image.

🎚️ Inputs

format

Required. The format of the output images that will be generated in the workspace [ png (Default), svg, eps, eps:text, pdf, vdx, xmi, scxml, html, txt, utxt, latex, latex:nopreamble, braille ].
See also: PlantUML Command Line: Types of Output File.

pattern

Required. The pattern of files/dirs that will be processed. It can include *, **, and ?. Example patterns are: **.puml (Default), doc/*.pu.
See also: PlantUML Command Line: Wildcards.

🖱️ Usage

Minimal
link:examples/plantuml.yml[role=include]
Customized
link:examples/plantuml.yml[role=include]

🛠️ Example

.github/workflows/plantuml.yml
link:examples/plantuml.yml[role=include]

📃 Code of Conduct

Please note that this project is release with the Contributor Covenant Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copyright © 2023-2024, Benno Bielmeier

Licensed under European Union Public License 1.2 (EUPL-1.2).

Rotary, Rotaract, and Interact are trademarks or registered trademarks of Rotary International and are used with the permission of Rotary International. Other trademarks not owned by Rotary International are the property of their respective owners. The license above does not grant any rights under trademark law and all such rights are reserved. Modified versions must be renamed to avoid use of any Rotary International trademarks, including but not limited to Rotary, Rotaract, and Interact.

All Rotary, Rotaract, and Interact logos and graphics are under copyright.