Utility project to test PlantUML files rendering and the "!include" directive in these files, that are used in the UML diagrams of the EMERALD project.
Utility project to test PlantUML files rendering and the "!include" directive in these files, that are used in the UML diagrams of the EMERALD project.
# !include in puml files
## !include in puml files
The typical "!include" directive of PlantUML (that search files in folders) doesn't work in Gitlab (see [Wiki Page Plantuml using !include](https://gitlab.com/gitlab-org/gitlab/-/issues/28847)). A workaround is to place the files in some url publicly available.
The typical "!include" directive of PlantUML (that search files in folders) doesn't work in Gitlab (see [Wiki Page Plantuml using !include](https://gitlab.com/gitlab-org/gitlab/-/issues/28847)). A workaround is to place the files in some url publicly available.
The UML files of EMERALD typically include several common files to define common graphical elements (arrows, colors, names, etc.). For example:
The UML files of EMERALD typically include several common files to define common graphical elements (arrows, colors, names, etc.). For example:
...
@@ -16,8 +16,9 @@ RCM Sequence Diagram
...
@@ -16,8 +16,9 @@ RCM Sequence Diagram
[..]
[..]
@enduml
@enduml
```
# PlantUML blocks
## PlantUML blocks
PlantUML blocks (**```plantuml** ... **```**) inside in markdown files didn't render in [Tecnalia's Gitlab](git.code.tecnalia.dev)(self-managed version), unlike in the Gitlab server where this is configured by default.
PlantUML blocks (**```plantuml** ... **```**) inside in markdown files didn't render in [Tecnalia's Gitlab](git.code.tecnalia.dev)(self-managed version), unlike in the Gitlab server where this is configured by default.
After completing the integration, PlantUML converts plantuml blocks to an HTML image tag, with the source pointing to the PlantUML instance. And the PlantUML diagram delimiters **@startuml/@enduml** aren’t required anymore, as these are replaced by the **plantuml** block.
After completing the integration, PlantUML converts plantuml blocks to an HTML image tag, with the source pointing to the PlantUML instance. And the PlantUML diagram delimiters **@startuml/@enduml** aren’t required anymore, as these are replaced by the **plantuml** block.
...
@@ -32,7 +33,7 @@ For additional acceptable extensions, review the languages.yaml file.
...
@@ -32,7 +33,7 @@ For additional acceptable extensions, review the languages.yaml file.
**07/2024**: This was solved [installing](https://docs.gitlab.com/administration/integration/plantuml/#configure-your-plantuml-server) the corresponding UML server and configuring git.code.tecnalia.dev to connect to it and finally render the plantUML text files as diagrams.
**07/2024**: This was solved [installing](https://docs.gitlab.com/administration/integration/plantuml/#configure-your-plantuml-server) the corresponding UML server and configuring git.code.tecnalia.dev to connect to it and finally render the plantUML text files as diagrams.
# PlantUML files
## PlantUML files
PlantUML files (*.uml, *.puml...) not rendering in GitLab repos was a long-time known issue (https://gitlab.com/gitlab-org/gitlab/-/issues/17325). The workaround for this could be to check out the repos locally and see the figures using Visual Studio Code with a PlantUML plugin or similar tools.
PlantUML files (*.uml, *.puml...) not rendering in GitLab repos was a long-time known issue (https://gitlab.com/gitlab-org/gitlab/-/issues/17325). The workaround for this could be to check out the repos locally and see the figures using Visual Studio Code with a PlantUML plugin or similar tools.
**02/2025**: It has been finally solved and included in the [release 19.7](https://gitlab.com/groups/gitlab-org/-/milestones/108)(see[merge request 179301](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179301)).Now the .pu or .puml files are rendered (when PlantUML integration is enabled) on the gitlab instance. It adds a rich view for graph files. Supported extensions are:
**02/2025**: It has been finally solved and included in the [release 19.7](https://gitlab.com/groups/gitlab-org/-/milestones/108)(see[merge request 179301](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/179301)).Now the .pu or .puml files are rendered (when PlantUML integration is enabled) on the gitlab instance. It adds a rich view for graph files. Supported extensions are:
