Description sommaire de l’intégration du script setup_main_tex_file.py avec git

README.md

@@ -242,3 +242,29 @@ La sous-commande _compile_ appelle rubber pour compiler les trois documents : di
 ./setup_main_tex_file.py compile -d modules_EOLE_envole/Conseil_Départemental
 ```
 Cette sous-commande n’est disponible que si la commande rubber est installé et accessible (test du retour rubber --version).
+
+### Intégration avec git
+
+Le script entreprend des actions complémentaires lorsque il détecte un environnement _git_.
+
+#### Séparation et isolation des formations
+
+La proposition est la suivante : séparer le contenu générique (contenu inclu dans les formations) et les fichiers maîtres spécifiques à des formations.
+
+Une branche (master en l’occurence) est utilisée comme pivot et contient les fragments de formations.
+Chaque formation spécifique est isolée dans une branche propre.
+
+De fait, le contenu du dossier _presentations_ est commité dans la branche spécifique, tandis que le reste (_content_ et _slides_ notamment) est commité dans _master_. Un hook git local est proposé pour limiter les commits dans les mauvaises branches, basé sur les chemins des fichiers créés ou modifiés.
+
+Le script permet d’automatiser une partie de ce découpage, notamment la création des branches spécifiques et le commit dans les branches appropriées selon les actions entreprises.
+
+#### action d’initialisation
+
+L’initialisation doit être effectué depuis la branche _master_ et exécute les actions suivantes :
+- création d’une branche nommée d’après le répertoire de destination et suffixée avec _xelatex/_
+- création des fichiers propres à la formation (fichiers maîtres pour le diaporama, le support, le programme, etc.)
+- commit de ces fichiers dans la branche spécifique.
+
+#### action de mise à jour du programme
+
+Comme tout ce qui implique la mise à jour ou la création de contenu dans le répertoire _presentations_, le produit de la mise à jour du programme est commité dans la branche spécifique.