Comment ajouter un répertoire vide à un référentiel Git


Garder votre référentiel Git bien organisé est essentiel pour avoir une base de code saine. Une mise en garde de git est que les dossiers vides ne seront pas validés par défaut. Cependant, il y a des occasions où il est avantageux d’avoir un dossier vide dans votre référentiel. Par exemple, votre code peut écrire des fichiers dans ce dossier à un moment donné, et il est utile s’il existe déjà sans que le code crée le dossier. Quelles que soient vos raisons, voici comment ajouter un dossier vide à un référentiel git.

Comment ajouter un répertoire vide à un référentiel Git

Pour ajouter un répertoire vide dans un Gite référentiel, ajoutez soit un .gitignore, .gitkeep, ou LISEZMOI fichier à l’intérieur du dossier. Chaque solution atteint l’objectif d’ajouter un fichier dans la structure de dossiers, forçant git à valider le dossier dans le référentiel. Nous passerons en revue les avantages et les inconvénients de chaque solution ci-dessous.

Option 1 : Ajouter .gitignore (préféré)

Notre solution préférée est d’ajouter un .gitignore avec le contenu suivant.

# Ignore all files and subdirectories in this folder
*
# Except the .gitignore file
!.gitignore

Ce fichier forcera git à ignorer tout le contenu de ce dossier à l’exception du fichier .gitignore lui-même. Cette approche est avantageuse si votre environnement de développement ajoute des fichiers que vous ne souhaitez pas valider dans votre dossier.

Option 2 : ajouter .gitkeep

Vous pouvez créer un vide .gitkeep dans votre dossier pour signifier que ce dossier doit rester dans le référentiel. Git ne prend pas officiellement en charge cette syntaxe de fichier, il ne faut donc pas la confondre avec un fichier git approprié. Lors de la validation de votre projet, git verra ce fichier .gitkeep caché et le validera avec le dossier.

Option 3 : ajouter un fichier LISEZMOI

Une autre approche consiste à ajouter un fichier README dans le dossier expliquant pourquoi ce répertoire vide doit être conservé dans le référentiel. Cette approche est utile si vous travaillez en équipe ou confiez le projet à quelqu’un d’autre. Vous voudrez peut-être ajouter un LISEZMOI accompagné d’un .gitignore fichier pour obtenir une solution plus complète et approfondie.

Vous disposez maintenant de plusieurs solutions pour ajouter un répertoire vide à un référentiel git. Choisissez ce qui fonctionne le mieux pour votre cas d’utilisation, mais envisagez d’utiliser les options un et trois ensemble pour une réponse solide et bien documentée.

Nous espérons que vous avez trouvé ce guide utile. Pour plus de guides comme celui-ci, veuillez consulter notre section de codage.

Laisser un commentaire