This page is part of the Documentation des guides d'implémentation de l'ANS (v0.1.7: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 0.1.8. For a full list of available versions, see the Directory of published versions

Usage de GitHub

GitHub est une sorte de sharepoint, un repository versionné avec un système de branche pour travailler de manière collaborative sur du contenu textuel (code, écriture, grammaire …)

Les branches: Un repository (ou répertoire) Github contient une arborescence de branche, permettant d’individualiser le travail de chacun puis de pousser son travail dans la branche de travail commune : typiquement main.

Reporter un problème (une issue)

Vous avez identifié une erreur sur un des guides ? L’onglet issue permet de signaler un problème sur un projet donné.

Un lien est également disponible sous chaque guide d’implémentation pour accéder aux issues :

L’issue doit contenir un titre, et une description très détaillée avec une proposition de changement.

Travailler sur un repository

GitHub peut s’utiliser de deux façons :

• Via l’application GitHub Desktop
• Via l’invite de commande

Git clone xxx

La commande git clone permet de copier l’intégralité d’un repository en local. Le xxx est à remplacer avec l’indication dans ssh :

Git checkout -b nom_travail_en_cours

Pour éviter que tout le monde travaille sur le même environnement, il faut créer une branche, et l’appeler par le nom du travail prévu dans cette branche . A ce moment là, vous pouvez faire les modifications en local, ces modifications seront reportées sur github pour tout le monde à l’issue des prochaines étapes

Git add fichiers_à_ajouter

Une fois les modifications établies, il faut dire à Git quels fichiers on souhaite ajouter au répertoire distant en faisant git add et en rajoutant le chemin vers les fichiers à ajouter (la commande git status permet de voir quels fichiers ont été modifiés)

Git commit -m “message sur la nature des travaux effectués”

Une fois les travaux menés (tout ou partie), il faut faire des commit : c’est à dire valider une modification fonctionnelle, cohérente. Cette étape peut être répétée plusieurs fois.

Git push

Cette commande pousse l’ensemble des modifications validées avec des commit sur le GitHub global.

Faire une Pull Request (PR)

Ensuite, il faut aller sur l’interface graphique, dans l’onglet, “Pull Requests”, et créer une nouvelle PR qui permet de dire : je veux intégrer les modifications que j’ai faites sur la branche x à la branche main. Chaque PR doit être validée par quelqu’un d’autre pour :

• Etre sûr que le savoir n’est pas concentré sur une personne
• Permettre une relecture pour éviter les erreurs

Mettre en place un workflow de validation/génération/publication

Afin de faciliter les actions au regards des IG, l’ANS met à disposition un GitHub Action avec les fonctionnalités suivantes :

• Lancement de sushi
• Tests avec le validateur_cli
• Incorporation des projets de simplifier (Methode bake)
• Publication des releases sur un repo github
• Génération du diagramme plantuml à partir de des données de l’IG
• Génération des diagrammes de mapping plantuml
• Génération des testscripts avec le projet testscript-generator
• Publication sur les pages github :
  • Diagramme de class plantuml généré à partir des données de l’IG
  • Rapport de validation du validator_cli