Файл .gitignore

Файл .gitignore — это текстовый файл, который говорит Git, какие файлы и директории нужно игнорировать при отслеживании изменений в репозитории. С помощью .gitignore можно исключить файлы, которые генерируются при сборке, содержат секретные данные или просто не нужны в проекте.

Где размещать файл

1. Корень репозитория: файл .gitignore обычно кладётся в корневую директорию репозитория. Это гарантирует, что правила игнорирования будут применяться ко всем файлам и директориям в проекте.

2. Вложенные директории: можно создавать файлы .gitignore и внутри других директорий. Тогда правила будут действовать только на файлы в этой конкретной директории и её поддиректориях.

Глобальный файл игнорирования

Помимо файла .gitignore в самом проекте, Git использует глобальный файл игнорирования, который применяется ко всем репозиториям в системе. Путь к этому глобальному файлу хранится в переменной конфигурации core.excludesFile.

git config --global core.excludesFile

Пример

# Можно добавлять комментарии для ясности. Они начинаются с символа решётки (#).
# Это комментарий!
 
# Игнорировать файлы с определёнными именами.
Thumbs.db
.DS_Store
 
# Игнорировать файлы с определёнными расширениями. Символ * (звёздочка) заменяет
# любые символы.
*.log
*.tmp
*.bak
 
# Игнорировать директории. Слэш в конце не обязателен, но он более явно
# указывает на то, что это именно директория.
logs
temp/
 
# Игнорировать файлы в любой директории с таким именем.
# Шаблон ** означает любую директорию, включая вложенные поддиректории.
**/build/
 
# Игнорировать файлы с определённым именем в конкретной директории.
docs/*.pdf
 
# Игнорировать все файлы в директории, кроме одного конкретного.
# Префикс ! инвертирует шаблон, поэтому файл не будет проигнорирован.
config/*
!config/main.conf
 
# Включить ранее проигнорированный файл, используя префикс !.
!important.log