Le contrôle de version est un outil essentiel pour suivre les modifications apportées à votre base de code, mais vous ne souhaitez pas toujours suivre chaque fichier.
Pour éviter l’encombrement et réduire le risque de distribution d’informations sensibles, vous pouvez utiliser un fichier appelé .gitignore. Ce fichier spécifie les fichiers et les répertoires que Git ne doit pas indexer.
Déterminer quels fichiers inclure dans .gitignore peut être un défi, en particulier si vous êtes novice en matière de développement. Découvrez quels fichiers vous devriez ajouter à votre .gitignore pour un flux de travail Git plus fluide.
Création d’un fichier .gitignore
Pour que votre fichier .gitignore ait un effet, vous devez avoir initialisé Git dans votre projet.
Vous pouvez initialiser Git en lançant la commande ci-dessous dans votre terminal :
git init
Cette commande crée un nouveau dépôt Git pour votre projet, dans un sous-répertoire caché « .git » qui contient tous les fichiers et répertoires nécessaires au contrôle de version de votre projet.
Pour exécuter cette commande, Git doit être installé sur votre système.
Ensuite, créez votre fichier .gitignore en exécutant la commande ci-dessous :
touch .gitignore
L’exécution de la commande ci-dessus crée un nouveau fichier, « .gitignore », dans votre répertoire actuel. Vous pouvez exclure un fichier de Git en ajoutant le nom du fichier ou son chemin d’accès (si le fichier se trouve dans un répertoire différent du répertoire .gitignore ).
Git n’a pas besoin de suivre tous les fichiers de votre projet, et le suivi de certains fichiers peut conduire à des problèmes imprévus. Voici quelques-uns des fichiers que vous devriez ajouter à votre .gitignore.
1. Fichiers de configuration
Les fichiers de configuration stockent des paramètres que vos applications utilisent pour définir et personnaliser leur comportement. Ces fichiers contiennent souvent des chaînes de connexion à des bases de données, des clés d’API et d’autres informations sensibles que vous ne devriez pas exposer dans votre dépôt Git.
Si vous incluez des fichiers de configuration dans votre dépôt, toute personne qui peut y accéder peut voir leur contenu. Cela peut inclure des informations sensibles, ce qui peut conduire à des failles de sécurité et à d’autres problèmes.
Pour exclure les fichiers de configuration de votre dépôt Git, ajoutez des noms de fichiers ou de dossiers spécifiques à votre fichier .gitignore fichier.
Par exemple, vous pouvez ajouter la ligne ci-dessous à votre fichier .gitignore pour ignorer un fichier .env fichier.
.env
2. Construire des artefacts
Les artefacts de construction sont les fichiers compilés ou générés lorsque vous construisez votre projet. Ces fichiers se trouvent généralement dans un répertoire « cible » ou « construire » répertoire.
Les artefacts de construction peuvent inclure des classes Java compilées, des fichiers JAR, des fichiers WAR, des fichiers binaires, des paquets de distribution, des rapports, des fichiers journaux et d’autres éléments générés au cours du processus de construction.
C’est généralement une bonne pratique d’exclure les artefacts de construction de votre dépôt Git car ils peuvent être très volumineux. Ils peuvent également être moins portables que vos fichiers sources, et ne concerner qu’un environnement spécifique. Les inclure dans votre dépôt peut gonfler la taille de votre dépôt et le rendre plus lent à cloner et à travailler.
Pour exclure les artefacts de construction de votre référentiel Git, ajoutez l’option « target/ » ou « build/ » dans votre répertoire .gitignore fichier.
Par exemple :
# .gitignore
target/
build/
3. Fichiers de l’environnement de développement intégré
Les fichiers de l’environnement de développement intégré (IDE) sont des fichiers de configuration, des métadonnées de projet et d’autres fichiers générés par votre IDE lorsque vous créez ou ouvrez un projet. Ces fichiers sont spécifiques à chaque IDE. Votre IDE utilise ces fichiers pour configurer les paramètres du projet.
Ces fichiers ne sont pas nécessaires à la construction ou à l’exécution de votre application et peuvent souvent causer des problèmes s’ils sont livrés dans un dépôt Git partagé. Par exemple, plusieurs personnes de votre équipe peuvent utiliser des IDE ou des versions différentes, et la livraison de fichiers spécifiques à l’IDE peut causer des conflits de fusion et rendre difficile la collaboration sur le projet.
Puisque ces fichiers sont spécifiques à l’IDE, les fichiers à inclure dans votre fichier .gitignore dépend de votre IDE. Voici les recommandations .gitignore de GitHub pour quelques IDE populaires. Vous pouvez rechercher l’IDE de votre choix et ajouter les fichiers décrits à votre fichier .gitignore fichier.
4. Dépendances et fichiers de paquets
Les fichiers de dépendances et de paquets sont des fichiers qui contiennent des informations sur les dépendances et les paquets utilisés par votre application. Divers outils de construction, tels que le gestionnaire de paquets Node (npm), génèrent ces fichiers.
Par exemple, si vous utilisez npm pour gérer les dépendances d’un projet JavaScript, il créera un fichier « node_modules« dans le répertoire racine de votre projet. Ce répertoire contient toutes les dépendances installées pour votre projet.
Ce répertoire peut devenir très volumineux, en particulier si votre projet comporte de nombreuses dépendances ou si certaines dépendances ont des fichiers de grande taille. En excluant le répertoire « node_modules« de votre dépôt Git, vous pouvez le garder propre et réduire sa taille.
Pour éviter d’ajouter le dossier « node_modulesPour ajouter le répertoire » node_modules » à votre dépôt Git, ajoutez son nom à votre fichier .gitignore :
#.gitignore
node_modules/
5. Fichiers du système d’exploitation
Votre système d’exploitation et d’autres outils système peuvent générer des fichiers dans le cadre d’une utilisation normale. Il peut s’agir de fichiers journaux, de fichiers temporaires et de fichiers de configuration du système. Un exemple est le fichier Thumbs.db sous Windows et son équivalent sous macOS, le fichier .DS_Store fichier.
C’est généralement une bonne pratique d’exclure les fichiers du système d’exploitation de votre dépôt Git, car ils sont spécifiques à votre environnement local et peuvent différer d’un ordinateur et d’un système d’exploitation à l’autre.
GitHub propose des recommandations .gitignore pour Windows, macOS et Linux.
L’importance du contrôle de version
L’utilisation du contrôle de version peut améliorer considérablement votre flux de travail et réduire les erreurs et les conflits qui peuvent survenir lorsque vous travaillez sur une base de code. Avec le contrôle de version, vous pouvez facilement suivre les modifications du code, les réviser et collaborer avec les membres de l’équipe de manière transparente.
Cependant, vous devez toujours exclure certains fichiers, tels que les fichiers de configuration, les fichiers de l’IDE et les fichiers du système d’exploitation. Cela vous permettra de réduire la taille de votre référentiel et de vous assurer que vous ne fuyez pas d’informations sensibles.
