Maj du guide de développement NALC

doc/Guide/dev-nalc.org

@@ -27,12 +27,12 @@ Faites la même opération avec les dépôts suivants :
     - [[https://sys4.fr/gitea/nalc/nalc-server-mods]]
     - [[https://sys4.fr/gitea/nalc/nalc_game]]
 
-Vos dépôts biffurqués (en tant qu'utilisateur Sam) seront accessibles à ces adresses :
+Vos dépôts bifurqués (en tant qu'utilisateur Sam) seront accessibles à ces adresses :
     - https://sys4.fr/gitea/Sam/nalc-server.git
     - https://sys4.fr/gitea/Sam/nalc-server-mods.git
     - https://sys4.fr/gitea/Sam/nalc_game.git
 *** Cloner votre bifurcation du dépot nalc-server
-Ouvrez un terminal bash depuis votre ordinateur puis faite un clone du dépôt que vous venez de biffurquer :
+Ouvrez un terminal bash depuis votre ordinateur puis faite un clone du dépôt que vous venez de bifurquer :
  #+begin_example :src shell
  $ cd ~
  $ git clone https://sys4.fr/gitea/Sam/nalc-server.git
@@ -163,7 +163,7 @@ lines 1-13/13 (END)
 #+end_src
 On voit bien le changement d'url pour le submodule riesenpilz.
 
-Le fichier .gitmodules étant modifié il est tant de faire un premier commit pour refléter ce changement dans le dépôt git nalc-server-mods :
+Le fichier .gitmodules étant modifié il est temps de faire un premier commit pour refléter ce changement dans le dépôt git nalc-server-mods :
 #+begin_src sh
 $ git status
 Sur la branche dev
@@ -353,3 +353,233 @@ Pour confirmer cette demande d'ajout, cliquer sur le bouton "Nouvelle demande d'
 
 Ensuite libre à lui de fusionner votre PR ou non.
 En tout cas de votre côté vous avez finalisé votre demande d'ajout.
+** Rester à jour avec la version officielle
+Si votre but est de proposer vos contributions pour la version officielle du serveur alors vous devrez merger les nouvelles mises à jour dans vos propres dépôts.
+Cette étape est importante car vous devez proposer vos modifications basées sur du code à jour.
+
+La règle est qu'avant d'entâmer une modification dans un dépôt, assurez-vous avant, de le mettre à jour avec la version officielle.
+*** Mettre à jour nalc-server
+ Rendez-vous avec votre terminal dans le dépôt de votre version de nalc-server :
+ #+begin_example
+ $ cd ~/nalc-server
+ #+end_example
+
+ Ajoutez le dépôt distant officiel de nalc comme dépôt distant secondaire (à faire qu'une seule fois) puis synchronisez votre dépôt local :
+ #+begin_example
+$ git remote add nalc https://sys4.fr/gitea/nalc/nalc-server.git # À faire une seule fois
+$ git fetch nalc # À faire à chaque fois que vous voulez vérifier la présence de mises à jours.
+Récupération de nalc
+remote: Décompte des objets: 8, fait.
+remote: Compression des objets: 100% (8/8), fait.
+remote: Total 8 (delta 5), reused 0 (delta 0)
+Dépaquetage des objets: 100% (8/8), 982 octets | 491.00 Kio/s, fait.
+Depuis https://sys4.fr/gitea/nalc/nalc-server
+ * [nouvelle branche] master     -> nalc/master
+ #+end_example
+
+Pour voir si de nouveaux commits ont été posté sur le dépôt officiel :
+#+begin_example
+$ git log --all
+commit 8af9d443e1feb9a112088aa7f16ffcea4e8ed995 (nalc/master)
+Author: sys4 <pouet@sys4.fr>
+Date:   Sat Oct 10 21:58:04 2020 +0200
+
+    [dev] Active le spawn des mobs en zones protégées
+
+commit 7aabf3af4d8114ed093c6f76f687b1ba575bc752
+Author: sys4 <pouet@sys4.fr>
+Date:   Sat Oct 10 21:33:02 2020 +0200
+
+    [dev] Maj des news
+
+commit 919e88a1ade3533db9b68cdfe9f81decf4bc8e9b
+Merge: 6270382 306fc03
+Author: sys4 <sys4@noreply.sys4.fr>
+Date:   Sat Oct 10 21:29:03 2020 +0200
+
+    Merge pull request 'Ajoute guide de contribution et de développement du serveur NALC' (#3) from posco/nalc-server:master into master
+    
+    Reviewed-on: https://sys4.fr/gitea/nalc/nalc-server/pulls/3
+
+commit 306fc03691de767fbf7f9246daffec87d9ee8d9f (HEAD -> master, origin/master, origin/HEAD)
+Author: sys4 <samedi@monemail.fr>
+Date:   Sat Oct 10 21:21:13 2020 +0200
+
+    Ajoute guide de contribution et de développement du serveur NALC
+
+lines 1-27
+#+end_example
+
+Nous pouvons voir que notre branche master actuelle (origin/master) est en retard par rapport à la branche master du dépôt officiel (nalc/master).
+
+Nous allons fusionner ces nouveaux commits dans notre propre dépôt puis les pousser vers le serveur.
+
+#+begin_example
+$ git merge nalc/master
+Mise à jour 306fc03..8af9d44
+Fast-forward
+ minetest-dev.conf  | 2 +-
+ world/news-dev.txt | 2 +-
+ 2 files changed, 2 insertions(+), 2 deletions(-)
+
+$ git push origin master
+Username for 'https://sys4.fr': Sam
+Password for 'https://samedi@monemail.fr': 
+Énumération des objets: 16, fait.
+Décompte des objets: 100% (13/13), fait.
+Compression par delta en utilisant jusqu'à 12 fils d'exécution
+Compression des objets: 100% (8/8), fait.
+Écriture des objets: 100% (8/8), 1002 octets | 1002.00 Kio/s, fait.
+Total 8 (delta 5), réutilisés 0 (delta 0), réutilisés du pack 0
+remote: 
+remote: Create a new pull request for 'Sam:master':
+remote:   https://sys4.fr/gitea/nalc/nalc-server/compare/master...Sam:master
+remote: 
+remote: . Processing 1 references
+remote: Processed 1 references in total
+To https://sys4.fr/gitea/Sam/nalc-server.git
+   306fc03..8af9d44  master -> master
+#+end_example
+
+Si un éventuel conflit est détecté pendant la fusion, git vous en avertira en mentionnant quels fichiers sont en conflits.
+Une fois que vous aurez résolu le conflit, vous pourrez finaliser la fusion avec la commande :
+#+begin_example
+$ git merge --continue
+#+end_example
+
+La fusion est terminée pour ce dépôt et le serveur est synchronisé.
+Faites la commande *git log* pour le vérifier.
+*** Mettre à jour nalc-server-mods
+Le début est à peu près la même chose. Voici la liste des commandes à faire.
+Cette fois je ne met pas le résultat des commandes pour simplifier la lecture.
+#+begin_example
+$ cd nalc-server-mods
+$ git remote add nalc https://sys4.fr/gitea/nalc/nalc-server-mods.git # Si première fois
+$ git fetch nalc
+$ git log --all
+#+end_example
+
+En revanche, les choses vont se compliquer à partir de maintenant.
+Quand vous allez fusionner la branche dev du dépôt officiel avec votre branche dev, les sous-modules de votre dépôt ne se mettrons pas à jour automatiquement et il faudra le faire manuellement. 
+
+#+begin_example
+$ git merge nalc/dev
+Échec de fusion du sous-module riesenpilz (commits non présents)
+Fusion automatique de riesenpilz
+CONFLIT (sous-module) : Conflit de fusion dans riesenpilz
+La fusion automatique a échoué ; réglez les conflits et validez le résultat.
+
+$ git status
+Sur la branche dev
+Votre branche est à jour avec 'origin/dev'.
+
+Vous avez des chemins non fusionnés.
+  (réglez les conflits puis lancez "git commit")
+  (utilisez "git merge --abort" pour annuler la fusion)
+
+Modifications qui seront validées :
+	modifié :         WorldEdit
+	modifié :         homedecor_modpack
+	modifié :         mesecons
+	modifié :         mobs
+	modifié :         moreblocks
+
+Chemins non fusionnés :
+  (utilisez "git add <fichier>..." pour marquer comme résolu)
+	modifié des deux côtés :  riesenpilz
+
+Modifications qui ne seront pas validées :
+  (utilisez "git add <fichier>..." pour mettre à jour ce qui sera validé)
+  (utilisez "git restore <fichier>..." pour annuler les modifications dans le répertoire de travail)
+	modifié :         WorldEdit (nouveaux commits)
+	modifié :         homedecor_modpack (nouveaux commits)
+	modifié :         mesecons (nouveaux commits)
+	modifié :         mobs (nouveaux commits)
+	modifié :         moreblocks (nouveaux commits)
+#+end_example
+
+De plus, et c'est notre cas ici aussi, vous aurez très certainement des conflits avec les sous-modules que vous aurez bifurqués auparavant et qui ont bénéficié de nouveaux commits dans les dépôts officiels. Peu importe que ces nouveaux commits soient issus de vos PR ou non.
+
+Mais *Pourquoi ?*
+Les sous-modules que vous avez modifiés, donc que vous avez bifurqués ne sont pas référencés à la même URL que les sous-modules officiels. L'historique de la branche dev de votre dépôt nalc-server-mods a dévié par rapport à la branche officielle qui elle ne connaît pas l'historique de votre dépôt puisqu'il n'a pas été fusionné. Du coup git considère que c'est un conflit et ne fera pas le merge automatiquement car il n'a pas moyen de savoir quoi faire. C'est à vous de décider.
+*Dans notre cas que faire concrètement ?*
+Pour nous sortir de ce mauvais pas nous allons pour chaque sous-module en conflit faire une fusion de la branche master du dépôt d'origine du sous-module puis nous ajouterons notre sous-module modifié à la fusion du dépôt nalc-server-mods.
+#+begin_example
+$ cd riesenpilz
+$ git remore add nalc https://sys4.fr/gitea/nalc/riesenpilz.git # Si première fois
+$ git fetch nalc
+$ git log --all
+$ git merge nalc/master
+# Réglez les éventuels conflits
+$ git push origin master
+$ cd ..
+$ git add riesenpilz
+$ git status
+Sur la branche dev
+Votre branche est à jour avec 'origin/dev'.
+
+Tous les conflits sont réglés mais la fusion n'est pas terminée.
+  (utilisez "git commit" pour terminer la fusion)
+
+Modifications qui seront validées :
+	modifié :         WorldEdit
+	modifié :         homedecor_modpack
+	modifié :         mesecons
+	modifié :         mobs
+	modifié :         moreblocks
+	modifié :         riesenpilz
+
+Modifications qui ne seront pas validées :
+  (utilisez "git add <fichier>..." pour mettre à jour ce qui sera validé)
+  (utilisez "git restore <fichier>..." pour annuler les modifications dans le répertoire de travail)
+	modifié :         WorldEdit (nouveaux commits)
+	modifié :         homedecor_modpack (nouveaux commits)
+	modifié :         mesecons (nouveaux commits)
+	modifié :         mobs (nouveaux commits)
+	modifié :         moreblocks (nouveaux commits)
+#+end_example
+
+Le sous-module riesenpilz corrigé apparaît maintenant dans les modifications qui seront validés pour la fusion en attente que nous pouvons maintenant terminer.
+
+#+begin_example
+$ git merge --continue
+$ git status
+Sur la branche dev
+Votre branche est en avance sur 'origin/dev' de 2 commits.
+  (utilisez "git push" pour publier vos commits locaux)
+
+Modifications qui ne seront pas validées :
+  (utilisez "git add <fichier>..." pour mettre à jour ce qui sera validé)
+  (utilisez "git restore <fichier>..." pour annuler les modifications dans le répertoire de travail)
+	modifié :         WorldEdit (nouveaux commits)
+	modifié :         homedecor_modpack (nouveaux commits)
+	modifié :         mesecons (nouveaux commits)
+	modifié :         mobs (nouveaux commits)
+	modifié :         moreblocks (nouveaux commits)
+
+aucune modification n'a été ajoutée à la validation (utilisez "git add" ou "git commit -a")
+#+end_example
+
+Il ne nous reste plus qu'à mettre à jour les sous-modules bénéficiants de nouveaux commits puis on pousse notre branche dev sur le serveur :
+#+begin_example
+$ git submodule update
+Chemin de sous-module 'WorldEdit' : '418a30c89e426f769365dd2955fcde1c0f35adb7' extrait
+Chemin de sous-module 'homedecor_modpack' : 'b6ecc0b95f322a391b87341d4321cb1c67da30c2' extrait
+Chemin de sous-module 'mesecons' : 'd356f901a3c26f2cce28ce0be64d26fff996e110' extrait
+Chemin de sous-module 'mobs' : '7f4d473feef7ab6df20d00e5ceaba8335efd463a' extrait
+Chemin de sous-module 'moreblocks' : 'b93949c26629489f586df9bdda5a9eb9fc977d34' extrait
+
+$ git status
+Sur la branche dev
+Votre branche est en avance sur 'origin/dev' de 2 commits.
+  (utilisez "git push" pour publier vos commits locaux)
+
+rien à valider, la copie de travail est propre
+
+$ git push origin dev
+$ git status
+Sur la branche dev
+Votre branche est à jour avec 'origin/dev'.
+
+rien à valider, la copie de travail est propre
+#+end_example