5 types de fichiers à inclure dans votre .gitignore

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 diffusion d'informations sensibles, vous pouvez utiliser un fichier appelé .gitignore. Ce fichier spécifie quels fichiers et répertoires Git ne doit pas indexer.

Déterminer quels fichiers inclure dans .gitignore peut être un défi, surtout si vous débutez dans le développement. Découvrez quels fichiers vous devez 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 exécutant la commande ci-dessous dans votre terminal :

git init

Cette commande crée un nouveau référentiel Git pour votre projet, dans un sous-répertoire caché ".git" qui contient tous les fichiers et répertoires dont il a besoin pour contrôler la version de votre projet.

Pour exécuter cette commande, vous devez avoir Git installé sur votre système.

Ensuite, créez votre fichier .gitignore en exécutant la commande ci-dessous :

touche.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 le chemin du fichier (si le fichier se trouve dans un répertoire différent du .gitignore déposer).

Git n'a pas besoin de suivre chaque fichier de votre projet, et le suivi de certains fichiers peut entraîner 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 les paramètres et d'autres paramètres que vos applications utilisent pour définir et personnaliser leur comportement. Ces fichiers stockent souvent des chaînes de connexion à la base de données, des clés API et d'autres informations sensibles que vous ne devez pas exposer dans votre référentiel Git.

Si vous incluez des fichiers de configuration dans votre référentiel, toute personne pouvant y accéder peut afficher leur contenu. Cela peut inclure des informations sensibles, ce qui peut entraîner des failles de sécurité et d'autres problèmes.

Pour exclure des fichiers de configuration de votre référentiel Git, ajoutez des noms de fichiers ou des noms de dossiers spécifiques à votre .gitignore déposer.

Par exemple, vous pouvez ajouter la ligne ci-dessous à votre .gitignore fichier pour ignorer un .env déposer.

.env

2. Construire des artefacts

Les artefacts de génération sont les fichiers compilés ou générés produits lorsque vous générez votre projet. Ces fichiers résident généralement dans un "cible" ou "construire" annuaire.

Les artefacts de génération peuvent inclure des classes Java compilées, des fichiers JAR, des fichiers WAR, des fichiers binaires, des packages de distribution, des rapports, des fichiers journaux et d'autres générés pendant le processus de génération.

Il est généralement recommandé d'exclure les artefacts de build de votre référentiel Git, car ils peuvent être très volumineux. Ils peuvent également être moins portables que vos fichiers source, uniquement pertinents pour un environnement spécifique. Les inclure dans votre référentiel peut augmenter la taille de votre référentiel et ralentir le clonage et l'utilisation.

Pour exclure les artefacts de build de votre référentiel Git, ajoutez le "cible/" ou "construire/" répertoire à votre .gitignore déposer.

Par exemple:

# .gitignore
cible/
construire/

3. Fichiers d'environnement de développement intégré

Les fichiers d'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 pour créer ou exécuter votre application et peuvent souvent causer des problèmes s'ils sont validés dans un référentiel Git partagé. Par exemple, différentes personnes de votre équipe peuvent utiliser différents IDE ou versions, et la validation de fichiers spécifiques à l'IDE peut provoquer des conflits de fusion et rendre difficile la collaboration sur le projet.

Comme ces fichiers sont spécifiques à l'IDE, les fichiers à inclure dans votre .gitignore dépendra de votre IDE. Voici Recommandations .gitignore de GitHub pour certains IDE populaires. Vous pouvez rechercher l'IDE de votre choix et ajouter les fichiers indiqués à votre .gitignore déposer.

4. Fichiers de dépendance et de package

Les fichiers de dépendance et de package sont des fichiers qui contiennent des informations sur les dépendances et les packages utilisés par votre application. Divers outils de construction, tels que le gestionnaire de paquets de nœuds (npm), générez ces fichiers.

Par exemple, si vous utilisez npm pour gérer les dépendances d'un projet JavaScript, il créera un "node_modules" dossier dans le répertoire racine de votre projet. Le répertoire contient toutes les dépendances installées pour votre projet.

Ce répertoire peut devenir très volumineux, surtout si votre projet comporte de nombreuses dépendances ou si certaines dépendances ont des fichiers de grande taille. En excluant le "node_modules" dossier de votre référentiel Git, vous pouvez le garder propre et réduire sa taille.

Pour éviter d'ajouter le "node_modules" dans 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 lors d'une utilisation normale. Ceux-ci peuvent inclure des fichiers journaux, des fichiers temporaires et des fichiers de configuration système. Un exemple est le Thumbs.db fichier sur Windows et son équivalent macOS, le .DS_Store déposer.

Il est généralement recommandé d'exclure les fichiers du système d'exploitation de votre référentiel Git, car ils sont spécifiques à votre environnement local et peuvent varier d'un ordinateur à l'autre et d'un système d'exploitation à l'autre. systèmes.

GitHub a recommandé des directives .gitignore pour les fenêtres, 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 pouvant survenir lorsque vous travaillez sur une base de code. Avec le contrôle de version, vous pouvez facilement suivre les modifications de 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 IDE et les fichiers du système d'exploitation. Cela réduira la taille de votre référentiel et vous assurera de ne pas divulguer d'informations sensibles.