Génération de diagrammes PlantUML avec Gitlab-CI

Le moyen le plus simple de garder les diagrammes à jour avec le code

C'est quoi ?

Les diagrammes sont :

  • décrits 100% par du texte
  • générés avec gitlab-ci
  • déployés sur gitlab-pages

Tellement facile à maintenir que vos diagrammes pourraient être encore à jour même 10 mois après le démarrage du projet!!!

Mais comment ?

Poussez simplement les sources des diagrammes et .gitlab-ci.yml se chargera de la génération des images & de la mise en ligne via pages :

Modèle physique de donnée avec fichiers partagés.

D.R.Y. !

L'utilisation de directives du préprocesseur PlantUML telles que !include ou !includeurl permet de partager des sources communes entre les diagrammes.

Dans mon exemple, les diagrammes marqués shared files partagent les mêmes entitiés :

  • associations
  • attributs
  • classes
  • clés
  • légende
  • relations

Par conséquent, si vous ajoutez quelque chose dans vos sources partagées, tous les diagrammes l'obtiendront !

«Talk is cheap. Show me the code.»

Type de diagramme Fichier seul Fichiers partagés
Domaine fonctionnel - (diagramme) - [source] - éléments communs
Domaine fonctionnel complet (diagramme) - [source] (diagramme) - [source] - éléments communs
Modèle physique de donnée (diagramme) - [source] (diagramme) - [source] - éléments communs