Add git hints

This commit is contained in:
nemunaire 2022-05-08 16:59:13 +02:00
parent fa37af6bb9
commit a56db671f5
2 changed files with 49 additions and 1 deletions

View File

@ -35,8 +35,12 @@ doivent respecter une certaine arborescence que voici :
└── ...
```
{{% notice warning %}}
Pour le bon usage et la bonne configuration de vos dépôts sur GitLab, veuillez consulter [la page dédiée]({{<relref "git">}}).
{{% /notice %}}
{{% notice info %}}
N'ajoutez pas inutilement de dossiers ou fichiers vides. Ceux-ci doivent sans doute être optionnels.
N'ajoutez pas inutilement de dossiers ou fichiers vides. Ceux-ci doivent sans doute être optionnels et risquent de vous/nous induire en erreur lors de nos vérifications.
{{% /notice %}}
Utilisez le binaire [repochecker](https://srs.nemunai.re/repochecker) (amd64/linux) pour vous assurer de votre arbrescence et de la validité du contenu des fichiers :

44
content/files/git.md Normal file
View File

@ -0,0 +1,44 @@
---
date: 2022-05-08T15:59:52+02:00
title: Consignes pour Git
weight: 5
---
Lorsque vous mettez en place vos dépôts Git sur la forge, il est important de respecter un certain nombre de consignes.
## Nommage du dépôt Git
Afin de standardiser l'accès à vos différents dépôts, ceux-ci doivent avoir l'URL suivante :
https://gitlab.cri.epita.fr/ing/majeures/srs/fic/YEAR/GRPID/scenario-X.git
Où :
- `YEAR` est l'année de votre promotion ;
- `GRPID` est le numéro de votre groupe au sein du projet FIC ;
- `X` est le numéro de votre scénario en commençant par 1.
Par exemple :
https://gitlab.cri.epita.fr/ing/majeures/srs/fic/2042/08/scenario-1.git
## Où mettre mon code source de mes binaires ?
Vous pouvez créer sur GitLab des dépôts pour vos différents projets liés à vos scénarios. N'hésitez pas à créer des dépôts à côté des dépôts de vos scénarios.
S'il s'agit d'un fichier ou d'un petit groupe de fichiers pour lequel créer un dépôt n'a pas d'intérêt, vous pouvez utiliser le dossier `resources` qui est présent dans chaque dossier d'étape de vos scénarios.
Il est important de NE PAS déclarer de sous-module (*submodule*) vers des dépôts externes à gitlab et de ne pas utiliser le dossier `resources` pour faire un lien vers des dépôts que l'on peut retrouver à côté du dépôt de votre scénario. Cela alourdi inutilement le processus de synchronisation.
## AUCUN FICHIER BINAIRE dans l'historique
Git est un gestionnaire de version qui gère particulièrement bien les fichiers texte, comme peuvent l'être les fichiers de code source.
Lorsqu'il est confronté à des fichiers binaires, Git perd toute son utilité car il est incapable de voir les différences entre ces fichiers.
Il en résulte qu'en cas de modification d'une image, d'un PCAP ou similaire, l'historique du dépôt est polué par des gros bouts d'octets sans intérêt.
Pour ne pas dégrader les performances de vos dépôts sur GitLab, vous DEVEZ utiliser LFS pour stocker vos fichiers binaires. De cette manière, ces fichiers, seront gérés par un processus de stockage différent (ils seront stockés sur S3 qui est capable de gérer une grosse quantité de gros fichiers, contrairement le volume RBD des dépôts Git).
Si vous pushez par mégarde un binaire sur vos dépôts, vous devrez sans doute le recréer de zéro. Donc faites attention.