Ne mettez pas toute votre vie dans les fichiers .gitignore

Cet article a été publié depuis plus de 6 mois, cela signifie que le contenu peut ne plus être d'actualité.

Lorsque l'on travaille avec un gestionnaire de version, il est souvent utile d'ignorer et de ne pas versionner certains fichiers et/ou dossiers. C'est extrêmement pratique pour ne pas pourrir votre dépôt avec des fichiers inutiles tel que des logs par exemple ou pour éviter de commiter de mauvais fichier par inadvertance. Dans Git cela se traduit par la création d'un fichier .gitignore (mais des mécanismes similaires existent pour les autres outils).

Une bonne pratique est de n'ajouter que des fichiers directement lié au projet concerné. Mais nous rencontrons tous, régulièrement, des projets avec des fichiers .gitignore "fourre tout" où l'on retrouve de nombreux fichiers divers et variés. Avoir un fichier .gitignore propre, c'est faciliter la compréhension de ce dernier, mais aussi de comprendre certains mécanismes de l'application et identifier des fichiers de logs générés par des traitements (et utile pour le debug).

Il est pourtant possible avec Git de définir un fichier .gitignore global qui sera appliqué par défaut sur tous les projets en plus du fichier local du dépôt de travail. Personnellement, ce dernier contient l'ensemble des fichiers automatiquement créés par les différents IDE que je suis ammené à utiliser.

On trouve également des modèles sur Github : https://github.com/github/gitignore

Pour le mettre en place, il suffit de créer un fichier ayant un format identique à n'importe quel fichier .gitignore et d'indiquer à Git de le prendre en compte via la commande :

git config --global core.excludesfile /path/to/.gitignore_global

Et voilà, le tour est joué et vous ne pourrirez plus les fichiers .gitignore de vos projets et vos collègues vous en remercieront.