Comment intégrer des diagrammes UML dans GitLab ou GitHub

Je veux le publier certains documentation de programmation, j'ai dans un public disponible référentiel. Cette documentation a du texte formaté, certains diagrammes UML, et beaucoup d'exemples de code. Je pense que GitHub ou GitLab sont de bons endroits pour le publier.

De publier les diagrammes UML, je voudrais avoir quelques facile de les tenir à jour dans le référentiel et le plus visible des images dans le wiki. Je ne veux pas garder les diagrammes dans mon ordinateur (ou sur le cloud), de les éditer, de générer une image, puis de le publier à chaque fois.

Est-il un moyen de mettre les diagrammes dans le référentiel (dans PlantUML syntaxe serait l'idéal), les lier dans le markdown, et de faire les images de mise à jour automatique à chaque fois que le schéma est mis à jour?

InformationsquelleAutor joanq | 2015-08-25
  1. 59

    Après avoir essayé l'autre réponse, j'ai découvert le service est lent et ne semble pas jusqu'à la dernière version de PlantUML.

    J'ai trouvé une autre manière qui n'est pas tout à fait aussi simple, mais il fonctionne via PlantUML.com's serveur (dans le nuage). En tant que tel, il devrait fonctionner n'importe où vous pouvez vous connecté à une image.

    Il exploite le !includeurl function et est essentiellement une indirection. La démarque des liens vers des fichiers à un PlantUML source qui inclut le diagramme de la source. Cette méthode permet de modifier le code source sur GitHub, et toutes les images dans le GitHub démarque des fichiers sera automatiquement mise à jour. Mais il nécessite une étape délicate pour créer l'URL de l'indirection.

    Comment intégrer des diagrammes UML dans GitLab ou GitHub

    1. D'obtenir l'URL du raw PlantUML source, par exemple, https://raw.githubusercontent.com/linux-china/plantuml-gist/master/src/main/uml/plantuml_gist.puml (à l'aide de l'exemple de la joanq réponse)

    2. Aller à http://plantuml.com/plantuml/form (ou PlantText.com) et de créer une ligne de PlantUML source qui utilise le !includeurl URL-TO-RAW-PLANTUML-SOURCE-ON-GITHUB opération. En continuant avec l'exemple d'URL, le PlantUML (méta)source:

      !includeurl https://raw.githubusercontent.com/linux-china/plantuml-gist/master/src/main/uml/plantuml_gist.puml

    3. Copier l'URL de l'image à partir de PlantUML.com l'image, par exemple, http://plantuml.com:80/plantuml/png/FSfB2e0m303Hg-W1RFPUHceiDf36aWzwVEl6tOEPcGGvZXBAKtNljW9eljD9NcCFAugNU15FU3LWadWMh2GPEcVnQBoSP0ujcnS5KnmaWH7-O_kEr8TU et de le coller dans votre GitHub démarque de fichier. Cette URL ne change pas.

      ![PlantUML model](http://plantuml.com:80/plantuml/png/3SNB4K8n2030LhI0XBlTy0YQpF394D2nUztBtfUHrE0AkStCVHu0WP_-MZdhgiD1RicMdLpXMJCK3TC3o2iEDwHSxvNVjWNDE43nv3zt731SSLbJ7onzbyeF)

    Bonus: Vous pouvez même obtenir l'accès au format SVG en modifiant la plantuml/png/ partie de l'URL plantuml/svg/ comme suit

    ![PlantUML model](http://plantuml.com:80/plantuml/svg/3SNB4K8n2030LhI0XBlTy0YQpF394D2nUztBtfUHrE0AkStCVHu0WP_-MZdhgiD1RicMdLpXMJCK3TC3o2iEDwHSxvNVjWNDE43nv3zt731SSLbJ7onzbyeF)

    Exemple sur GitHub

    https://github.com/fuhrmanator/course-activity-planner/blob/master/ooad/overview.md

    Edit: Alternative avec service de Proxy

    De cette façon est sensiblement différent et plus simple que la réponse ci-dessus; il utilise le PlantUML service de proxy:

    http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt

    Le GitHub de markdown pour ce serait:

    ![alternative text](http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt)

    Cette méthode souffre de ne pas être en mesure de spécifier le format SVG (la valeur par défaut PNG), et c'est peut-être pas possible de travailler autour de la mise en cache bug mentionné dans les commentaires.

    • Je ne suis pas sûr qu'il est parfait, parce que GitHub caches des images à partir de .md fichiers dans son camo.githubusercontent.com site. J'ai actuellement un cas d'utilisation schéma que j'ai mis à jour, mais les mises à jour n'a pas eu à le .md fichier après plusieurs jours, même quand j'ai mis à jour d'autres parties de la .md fichier. J'ai peut-être de toucher les pièces qui font référence à l'image. YMMV.
    • En effet, GitHub semble être la seule à mettre à jour son cache camo site de photos lorsque l'URL correspond à l'URL de l'image. Une façon de mettre à jour l'URL sans changer il est à ajouter/supprimer des .svg (ou .png si vous utilisez ce format). PlantUML ne se soucie pas si vous en avez l'extension à la fin, mais GitHub vont penser que vous avez changé l'URL et mettre à jour son cache en camo.. Voir github.com/fuhrmanator/course-activity-planner/commit/... pour plus de détails.
    • Je ne pense pas que GitLab est la mise en cache des images de la même manière, donc il ne devrait pas être un problème dans mon cas, mais il est bon de savoir comment le résoudre, juste au cas où.
    • pour éviter la mise en cache juste ajouter quelques paramètres à l'url par exemple plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/... et de l'incrémenter à chaque fois que le fichier uml(test2diagrams.txt) est modifié
    • Pour éviter la mise en cache cache=no paramètre de l'url doit être ajoutée: plantuml.com/plantuml/proxy?cache=no&src=https://...
    • Le problème de mise en cache est avec GitHub et pas PlantUML, donc je ne suis pas sûr de savoir comment ce cache drapeau de l'aide.
    • problème de mise en cache est toujours le problème de navigateur, pas GitHub ou PlantUML. Lorsque vous utilisez cache=no paramètre d'url, PlantUML serveur de jeu Cache-Control: no-cache en-tête, de sorte que le navigateur ne sera pas mis l'image en mémoire cache. Lorsque vous appuyez sur F5 dans le navigateur, une nouvelle demande pour l'image sera fait pour PlantUML serveur. Si vous passer github url de la branche principale, comme src (pas de commentaire spécifique), puis PlantUML demande la dernière version de fichier et retourner à jour de l'image.
    • est-il un moyen de faire ce pour pour le privé, les pensions de trop?
    • FYI - svg travaille maintenant sur le proxy.
    • "Alternative avec Service de Proxy" fonctionne à merveille. La façon de l'obtenir pour fonctionner avec salle de repos est à inclure la ?token=<LONGSTRINGHERE> dans le cadre de la première url. Malheureusement, ce jeton se modifie à chaque édition de la plantuml source, de sorte que vous avez à travailler un peu pour garder la démarque doc à jour. Mais c'est faisable.

    InformationsquelleAutor Fuhrmanator
  2. 11

    J'ai trouvé qu'il est possible de le faire à l'aide de plantuml-gist sur http://uml.mvnsearch.org/

    Il suffit de mettre un valide puml fichier dans le référentiel et d'inclure un lien vers ce site dans la documentation.

    Par exemple, pour le fichier https://github.com/linux-china/plantuml-gist/blob/master/src/main/uml/plantuml_gist.puml sur GitHub, vous pouvez utiliser http://uml.mvnsearch.org/github/linux-china/plantuml-gist/blob/master/src/main/uml/plantuml_gist.puml que votre lien.

    Voici à quoi il ressemble lié à StackOverflow:

    UML image http://uml.mvnsearch.org/github/linux-china/plantuml-gist/blob/master/src/main/uml/plantuml_gist.puml

    Malheureusement, il ne semble pas fonctionner avec GitLab. J'ai toujours été un "Non PUML fichier trouvé", même si j'ai vérifié le chemin plusieurs fois.

    MODIFIER: serveur au uml.mvnsearch.org semble.

    • Ce serait encore plus cool si vous avez montré un exemple de gollum le balisage wiki, mais elle est assez bonne figure.
    • Il semble que le serveur qui uml.mvnsearch.org est l'aide de n'en connaît pas la dernière PlantUML langue. J'ai posté une réponse qui utilise PlantUML.com s'serveur cloud.
    • emedded lien de l'image, éventuellement cassé
    InformationsquelleAutor joanq
  3. 2

    C'est une vieille question, mais il arrive tôt dans la recherche de solutions à ce problème.

    Autres réponses discuter de GitHub, mais il est intéressant de noter que GitLab a l'intégration native pour cela, si vous êtes le déploiement en interne. Pour une raison quelconque, ils n'ont jamais activé la fonction sur leur appel public à l'épargne. Il y a les billets d'ouvrir pour activer la fonction.

    Si vous travaillez à une solution hébergée, il y a des instructions disponibles dans la l'administration de la documentation

    Fondamentalement, vous

    1. se lever de votre propre plantuml serveur
    2. vérifier la Enable PlantUml dans GitLab de configuration du serveur
    3. écrire PlantUml dans votre markdown
    ```plantuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
```
    InformationsquelleAutor Jefferey Cave