RootsLabs

More than a tool ! GitHub Google+ LinkedIn RSS

Publier automatiquement une PHPDoc sur GitHub avec Travis CI

Progi1984 - Commentaires (3)

Votre projet PHP utilise Travis CI pour l’intégration continue. Vous souhaitez générer une documentation PHP via PHPDoc et la fournir à vos utilisateurs. Et si on utilisait les GitHub Pages pour vous héberger ? Dans cet article, je vais vous montrer comment utiliser Travis CI pour générer la documentation avec PHPDoc et la pousser vers les pages GitHub.

Travis

Pré-Requis

Tout d’abord, certains pré-requis sont indispensables :

Token d’acces et .travis.yml

Après avoir récupéré votre token d’accès, on va le crypter pour que Travis puisse l’utiliser :

Après avoir récupéré ce token crypté, on va l’ajouter au fichier .travis.yml où l’on va mettre juste après la section lié aux versions de PHP :

PHPDoc et .travis.yml

Maintenant que notre token d’accès est crypté, on va installer PHPDoc. Pour cela, on va utiliser la section du composer.json nommé « require-dev » pour l’installer :

Après avoir avoir géré l’installation de PHPDocumentor, on va modifier le fichier .travis.yml pour gérer la génération :

Pour la partie after_script, on utilise un script maison qui récupère le projet, nettoie et copie la documentation avant de l’envoyer vers GitHub.

Conclusion

Et voilà, désormais, on aura un dossier de documentation pour chaque branche du projet. Ainsi la documentation de la branche develop n’écrasera pas la documentation de la branche master à chaque commit, et un développeur saura facilement s’y retrouver. Maintenant que l’on sait pusher des fichiers sur GitHub depuis Travis-CI, cela ouvre de nouvelles possibilités : rapport de couverture de code en HTML, script qui convertit du Markdown en HTML avant de le pousser, etc…

Commentaires

1. Laurent, le 21 août 2014 à 22:04

Bonjour,
As-tu déjà rencontré un problème avec GraphViz ?
J’ai ce message d’erreur :
Transform analyzed project into artifacts .. Unable to find the dot command of the GraphViz package. Is GraphViz correctly installed and present in your path? 8.388s
J’ai pourtant le dossier GraphViz dans mon dossier phpDocumentor de mon Vendor de Symfony2…
Laurent

2. Progi1984, le 21 août 2014 à 22:37

@Laurent : Je pense que tu dois être sous Windows. As tu ajouté le répertoire où est stockée l’exécutable dot à la variable d’environnement PATH ?

3. Использования Travis CI для генерации документации, le 21 juillet 2015 à 09:09

[…] P.S. При написании данного руководства использовались материалы из статьи Publier automatiquement une PHPDoc sur GitHub avec Travis CI […]

Ajouter un commentaire

Commentaire :