11. Utiliser .gitignore pour ignorer les fichiers
Le contrôle de version est un outil essentiel pour les développeurs de logiciels et les équipes informatiques. Git, l'un des systèmes de contrôle de versions les plus populaires, permet aux équipes de collaborer efficacement sur des projets. Cependant, tous les fichiers d'un projet ne doivent pas nécessairement être suivis par Git. C'est là que le fichier .gitignore
devient un outil précieux. Dans cette section, nous explorerons le but de .gitignore
, comment le créer et l'utiliser pour garder votre référentiel propre et exempt de fichiers inutiles.
Qu'est-ce que le fichier .gitignore ?
Le fichier .gitignore
est un simple document texte qui indique à Git quels fichiers ou répertoires ignorer et ne pas suivre. Lorsqu'un fichier est ignoré, il n'est pas ajouté au référentiel, même si vous utilisez des commandes comme git add .
ou git commit -a
. Ceci est utile pour exclure les fichiers temporaires, les fichiers de configuration personnels, les répertoires de dépendances tels que node_modules
et les fichiers compilés, qui ne doivent pas être partagés avec d'autres collaborateurs ou ne sont pas requis pour exécuter le projet.
Création d'un fichier .gitignore
Pour créer un fichier .gitignore
, créez simplement un nouveau fichier texte à la racine de votre projet Git et nommez-le .gitignore
(le point au début est important car cela indique qu'il s'agit d'un fichier caché sur les systèmes de type Unix). Dans ce fichier, vous spécifierez les valeurs par défaut des fichiers et répertoires que vous souhaitez ignorer.
Syntaxe .gitignore
La syntaxe de .gitignore
est simple. Voici quelques règles de base :
- Les lignes vides sont ignorées.
- Les lignes commençant par
#
sont considérées comme des commentaires et sont ignorées. - Les modèles globaux sont pris en charge, tels que
*
pour correspondre à n'importe quelle séquence de caractères et?
pour correspondre à un seul caractère. - Pour ignorer un répertoire entier, placez une barre oblique (
/
) à la fin du nom du répertoire. - Pour annuler un modèle (c'est-à-dire inclure des fichiers ou des répertoires qui seraient autrement ignorés), placez un point d'exclamation (
!
) au début du modèle.
Exemples d'utilisation de .gitignore
Voyons quelques exemples d'utilisation du fichier .gitignore
:
# Ignorer tous les fichiers .log
*.enregistrer
# Ignorer le répertoire de construction
construire/
# Ignorer le fichier my_secret_file.txt
mon_fichier_secret.txt
# Ignorer tous les fichiers du dossier docs à l'exception du fichier README.md
documents/*
!docs/README.md
# Ignorer tous les fichiers .txt sauf LICENSE.txt
*.SMS
!LICENSE.txt
Fichiers .gitignore globaux et locaux
En plus du fichier .gitignore
spécifique au projet, les utilisateurs peuvent définir un fichier .gitignore
global qui s'applique à tous les projets Git sur leur machine. Pour configurer un fichier global .gitignore
, utilisez la commande suivante :
git config --global core.excludesfile '~/.gitignore_global'
Ensuite, vous pouvez créer le fichier .gitignore_global
dans votre répertoire utilisateur et ajouter les règles que vous souhaitez appliquer globalement.
Ignorer les fichiers déjà analysés
Si vous ajoutez un fichier à .gitignore
après qu'il ait déjà été suivi par Git (c'est-à-dire après qu'il ait été ajouté à l'index), Git continuera à le suivre. Pour arrêter le suivi d'un fichier déjà dans l'index, vous devez le supprimer explicitement avec la commande :
git rm --cached [fichier]
Cela supprimera le fichier de l'index mais conservera la copie locale intacte.
Bonnes pratiques avec .gitignore
Lorsque vous travaillez avec .gitignore
, il existe quelques bonnes pratiques à suivre :
- Commentez votre
.gitignore
pour expliquer pourquoi certains fichiers sont ignorés. - Gardez
.gitignore
à jour à mesure que de nouveaux fichiers et répertoires inutiles sont créés. - Utilisez les modèles
.gitignore
pour des langages et outils de programmation spécifiques. Vous pouvez trouver des exemples sur GitHub à l'adresse https://github.com/github/gitignore. - Partagez
.gitignore
avec votre équipe pour vous assurer que tout le monde ignore les mêmes types de fichiers.
Conclusion
Le fichier .gitignore
est un outil puissant dans l'arsenal d'un développeur pour garder les référentiels Git propres et concentrés uniquement sur l'essentiel. En comprenant et en utilisant efficacement .gitignore
, vous pouvez éviter d'inclure des fichiers inutiles et sensibles, ce qui contribue à maintenir l'intégrité et la sécurité de votre projet. Souviens-toiAssurez-vous que .gitignore
est flexible et peut être ajusté si nécessaire pour répondre aux besoins spécifiques de votre projet et de votre équipe.
Grâce à ces informations, vous êtes bien équipé pour créer et gérer le fichier .gitignore
dans vos projets Git et GitHub, en garantissant que seuls les fichiers pertinents sont suivis et partagés avec d'autres collaborateurs.