Un fichier avec l'extension de fichier GITIGNORE est un fichier Git Ignore utilisé avec le système de contrôle de version/source appelé Git.
Qu'est-ce qu'un fichier GITIGNORE ?
Un fichier Git Ignore spécifie quels fichiers et dossiers doivent être ignorés dans un code source donné.
Il peut être utilisé par chemin afin que les règles ne soient appliquées qu'à des dossiers spécifiques, mais vous pouvez également créer un fichier GITIGNORE global qui s'applique à chaque référentiel Git dont vous disposez.
Vous pouvez trouver des dizaines d'exemples de fichiers GITIGNORE recommandés dans divers scénarios, sur la page des modèles.gitignore de GitHub.
Comment ouvrir un fichier GITIGNORE
Les fichiers GITIGNORE sont des fichiers texte brut, ce qui signifie que vous pouvez en ouvrir un avec n'importe quel programme capable de lire des fichiers texte.
Les utilisateurs de Windows peuvent ouvrir les fichiers GITIGNORE avec le programme Bloc-notes intégré ou avec l'application gratuite Notepad++. Pour ouvrir les fichiers GITIGNORE sur macOS, vous pouvez utiliser Gedit. Les utilisateurs Linux (ainsi que Windows et macOS) peuvent trouver Atom utile pour ouvrir et éditer des fichiers GITIGNORE.
Cependant, les fichiers GITIGNORE ne sont pas réellement utilisables (c'est-à-dire qu'ils ne fonctionnent pas comme un fichier ignoré) à moins qu'ils ne soient utilisés dans le contexte de Git, qui est un logiciel gratuit qui s'exécute sous Windows, Linux et macOS.
Vous pouvez utiliser le fichier GITIGNORE en le plaçant là où vous voulez que les règles s'appliquent. Mettez-en un différent dans chaque répertoire de travail et les règles d'ignorance fonctionneront pour chaque dossier individuellement. Si vous placez le fichier GITIGNORE dans le dossier racine du répertoire de travail du projet, vous pouvez y ajouter toutes les règles afin qu'il assume un rôle global.
Ne placez pas le fichier GITIGNORE dans le répertoire du référentiel Git; cela ne permettra pas aux règles de s'appliquer puisque le fichier doit être dans le répertoire de travail.
Les fichiers GITIGNORE sont utiles pour partager les règles d'ignorance avec toute autre personne susceptible de cloner votre référentiel. C'est pourquoi, selon GitHub, il est important de le valider dans votre référentiel.
Comment convertir vers/depuis un fichier GITIGNORE
Consultez ce fil Stack Overflow pour plus d'informations sur la conversion de CVSIGNORE en GITIGNORE. La réponse simple est qu'il n'y a pas de convertisseur de fichier standard qui puisse le faire pour vous, mais il peut y avoir un script que vous pouvez utiliser pour copier les modèles du fichier CVSIGNORE.
Voir Comment convertir des référentiels SVN en référentiels Git pour obtenir de l'aide. Consultez également ce script Bash qui pourrait peut-être réaliser la même chose.
Pour enregistrer votre fichier GITIGNORE dans un format de fichier texte, utilisez l'un des éditeurs de texte mentionnés ci-dessus. La plupart d'entre eux peuvent être convertis en TXT, HTML et autres formats de texte brut similaires.
Lecture avancée sur les fichiers GITIGNORE
Vous pouvez construire un fichier GITIGNORE local depuis Terminal, avec cette commande:
touchez.gitignore
Un global peut être créé comme ceci:
git config --global core.excludesfile ~/.gitignore_global
Sinon, si vous ne souhaitez pas créer de fichier GITIGNORE, vous pouvez ajouter des exclusions à votre référentiel local en modifiant le fichier.git/info/exclude.
Voici un exemple simple de fichier GITIGNORE qui ignorerait divers fichiers générés par le système d'exploitation:
. DS_Store
. DS_Store?
._. Trashes
ehthumbs.dbThumbs.db
Voici un exemple GITIGNORE qui exclut les fichiers LOG, SQL et SQLITE du code source:
.log
.sql.sqlite
Il existe de nombreuses règles de modèle qui doivent être suivies afin de respecter les règles de syntaxe appropriées exigées par Git. Vous pouvez lire à ce sujet, et bien plus sur le fonctionnement du fichier, sur le site Web officiel de la documentation GITIGNORE.
Assurez-vous de vous rappeler que si vous avez déjà archivé un fichier à ne pas ignorer, puis que vous ajoutez ultérieurement une règle d'ignorance pour celui-ci dans le fichier GITIGNORE, Git n'ignorera pas le fichier tant que vous ne l'aurez pas suivi avec le commande suivante:
git rm --cached nomdufichier
Votre fichier ne s'ouvre toujours pas ?
Si votre fichier ne fonctionne pas comme décrit ci-dessus, vérifiez que vous lisez correctement l'extension du fichier. Par exemple, si vous ne pouvez pas l'ouvrir avec un éditeur de texte ou si Git ne reconnaît pas le fichier, il se peut que vous n'ayez pas vraiment affaire à un fichier GITIGNORE.
IGN est un autre fichier ignoré, mais au format de fichier RoboHelp Ignore List créé par et utilisé avec Adobe RoboHelp pour créer des documents d'aide Windows. Bien que le fichier puisse remplir une fonction similaire - pour répertorier les mots qui sont ignorés des recherches dans la documentation - il ne peut pas être utilisé avec Git et ne suit pas les mêmes règles de syntaxe.
Si votre fichier ne s'ouvre pas, recherchez son extension de fichier pour savoir dans quel format il se trouve afin de trouver le logiciel approprié qui l'ouvre ou le convertit.
FAQ
Comment puis-je voir ce qu'il y a dans mon GITIGNORE ?
Vous pouvez ouvrir le fichier avec l'éditeur de texte de votre choix. Vous pouvez également utiliser la commande git check-ignore pathname pour voir si un fichier particulier est sur la liste des ignorés.
Qu'est-ce que GITIGNORE et GITATRIBUTES dans Visual Studio ?
Le fichier GITIGNORE répertorie les éléments non suivis par un référentiel Git, tandis que le fichier GITATTRIBUTES spécifie comment gérer des fichiers particuliers en fonction du nom de chemin. Vous pouvez ouvrir et modifier les deux fichiers dans Visual Studio à partir de Repository Settings > Ignore & Attributes Files
Comment puis-je GITIGNORE un dossier ?
Si vous voulez ignorer le contenu d'un répertoire particulier, ouvrez votre fichier GITIGNORE et tapez nom_dossier /.
