Uncategorised

GitLab Tutorials: Gitlab integration with PlantUML

September 9, 2022 Leave a Comment

What is PlantUML?

PlantUML is an open-source tool allowing users to create diagrams from a plain text language. Besides various UML diagrams, PlantUML has support for various other software development related formats, as well as visualisation of JSON and YAML files. The language of PlantUML is an example of a domain-specific language.

PlantUML Capabilities

PlantUML is a component that allows you to quickly write:

  • Sequence diagram
  • Usecase diagram
  • Class diagram
  • Object diagram
  • Activity diagram (here is the legacy syntax)
  • Component diagram
  • Deployment diagram
  • State diagram
  • Timing diagram

The following non-UML diagrams are also supported:

  • JSON data
  • YAML data
  • Network diagram (nwdiag)
  • Wireframe graphical interface or UI mockups (salt)
  • Archimate diagram
  • Specification and Description Language (SDL)
  • Ditaa diagram
  • Gantt diagram
  • MindMap diagram
  • Work Breakdown Structure diagram (WBS)
  • Mathematic with AsciiMath or JLaTeXMath notation
  • Entity Relationship diagram (IE/ER)

PlantUML and GitLab

When the PlantUML integration is enabled and configured in GitLab, you can create diagrams in snippets, wikis, and repositories. This integration
is enabled on GitLab.com for all SaaS users and does not require any additional configuration.

To set up the integration on a self-managed instance, you must:

Rajesh Kumar
Follow me
Latest posts by Rajesh Kumar (see all)
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x