Création d’un package open-source pour la production d’un rapport d’historique de git

Contexte et enjeux de la mission

Cette entreprise pharmaceutique se lance dans la mise en production d’applications Shiny et de scripts d’analyses de données avec R, après avoir utilisé SAS pendant de nombreuses années. Les développements au sein des entreprises pharmaceutiques sont très réglementés. Ils nécessitent un reporting transparent et rigoureux des modifications réalisées sur le code tout au long du processus de développement. Ceci passe par la création d’un rapport qui liste toutes les modifications du code en utilisant les infos des commits de git, à savoir :

  • la date du commit
  • le nom des développeurs
  • la partie du code impactée
  • le contenu du message de commit qui est sensé être complet et renseigné scrupuleusement, indiquant :
    • la raison de la modification
    • la liste des tickets associés (i.e. issues)

Notre intervention

  • Réflexion sur les éléments que doit contenir le rapport
  • Création d’un package R qui crée de manière automatisée le rapport sur la base de l’historique git d’un projet

Résultat & valeur ajoutée

  • Un package R open-source : {gitdown}
  • Une création d’un livre {RMarkdown} réalisé via {bookdown} qui liste tous les commits historisés dans git et qui contient :
    • un chapitré dédié aux tickets (i.e. issues), avec une section pour chacun des tickets
    • des chapitres dédiés aux différentes phases du processus de développement (i.e. développement, mise en production, recette, etc.)
  • {bookdown} pour générer le livre
  • Un article de blog sur la création de rapports d’historique git

Nos derniers Use Cases