From 2b031286e718094aa5af7d140f35033cea5756cd Mon Sep 17 00:00:00 2001 From: Benjamin Bohard Date: Mon, 1 Feb 2021 14:19:30 +0100 Subject: [PATCH] =?UTF-8?q?Description=20sommaire=20de=20l=E2=80=99int?= =?UTF-8?q?=C3=A9gration=20du=20script=20setup=5Fmain=5Ftex=5Ffile.py=20av?= =?UTF-8?q?ec=20git?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 27f7ad7..9cc6fe4 100644 --- a/README.md +++ b/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.