Scroll back to the top

UML diagrams in GitLab

[ uml gitlab ]

We use GitLab in our team. It’s handy to use UML in the process on any stage. But drawing takes too much time. That’s why it’s better to use plain text online editor PlantUML to compose in pure declarative way the UML diagram or ER-diagram schema.

' hide the spot
hide circle

' avoid problems with angled crows feet
skinparam linetype ortho

entity "Entity01" as e01 {
  *e1_id : number <<generated>>
  *name : text
  description : text

entity "Entity02" as e02 {
  *e2_id : number <<generated>>
  *e1_id : number <<FK>>
  other_details : text

entity "Entity03" as e03 {
  *e3_id : number <<generated>>
  e1_id : number <<FK>>
  other_details : text

e01 ||..o{ e02
e01 |o..o{ e03

The tool can generate PNG file, that we can attach to a description or a comment in GitLab.

ER-diagram example

Besides, we can save plain-text source of diagram to the file and commit it. Later, correct it and even check by git diff, which is not possible with diagram in the form of a PNG image.

More examples:

participant User

User -> A: DoWork
activate A

A -> B: << createRequest >>
activate B

B -> C: DoWork
activate C
C --> B: WorkDone
destroy C

B --> A: RequestCreated
deactivate B

A -> User: Done
deactivate A

Sequence Diagram  example