Файл gitignore

Файл .gitignore используется для того, чтобы определить какие файлы и папки не нужно добавлять в git репозиторий.

Мы конечно могли бы вручную добавлять нужные файлы в репозиторий, например так:

git add path/to/file

Однако это было бы очень трудоемко, гораздо проще использовать команду которая добавит все файлы в каталоге проекта:

git add .

Но что если нам не нужны абсолютно все файлы, а есть файлы например в каталоге /cache или /images или /runtime проекта, которые генерируются в процессе работы. Они не должны быть добавлены в репозиторий.

Где должен находиться этот файл

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

Примеры содержимого .gitignore файла:

# Игнорировать каталог в любом месте
node_modules/

# Игнорировать файлы логов в любом месте
*.log

# Игнорировать каталог в корне
/dist

# Игнорировать файл с окончанием
.env

Построение шаблонов

Символ #

Строки начинающиеся с решетки #, являются комментариями и игнорируются. Пустые строки можно использовать для улучшения читаемости файла и для группировки связанных строк шаблонов.

Без символов

Если шаблон не начинается с косой черты, он соответствует файлам и каталогам в любом каталоге или подкаталоге, в котором находится .gitignore.

access.log  # Примеры совпадений: access.log и logs/access.log и var/logs/access.log

Символ /

/ в начале шаблона относится к каталогу или файлу, который находится в корне репозитория где находится файл .gitignore. Когда каталог игнорируется, все его файлы и подкаталоги также игнорируются.

/access.log  # Примеры совпадений: access.log

/ в конце шаблона, соответствует только каталогам. Когда каталог игнорируется, все его файлы и подкаталоги также игнорируются.

build/  # Примеры совпадений: build

Символ *

* символ звездочки соответствует нулю или более символам.

*.log  # Примеры совпадений: error.log и logs/debug.log и build/logs/error.log

Символ **

** два символа звездочки соответствуют любому файлу или нулю или более каталогам.

Если за ** следует косая черта /, соответствует только каталогам.

logs/**  # Примеры совпадений: соответствует чему-либо в каталоге logs

**/build  # Примеры совпадений: var/build и pub/build и build

foo/**/bar  # Примеры совпадений: foo/bar и foo/a/bar и foo/a/b/c/bar

Символ ?

? знак вопроса соответствует любому одиночному символу.

access?.log  # Примеры совпадений: access0.log и access1.log и accessA.log

foo??  # Примеры совпадений: fooab и foo23 и foo0s

Символ [...]

[...] соответствует любому из символов, заключенных в квадратные скобки. Когда два символа разделены - это обозначает диапазон символов. Диапазон включает все символы, которые находятся между этими двумя символами. Диапазоны могут быть буквенными или числовыми.

Если первый символ после [ отрицание в виде !, шаблон соответствует любому символу, кроме символов из указанного набора.

*.[oa]  # Примеры совпадений: file.o и file.a

*.[!oa]  # Примеры совпадений: file.s и file.1 и file.0

access.[0-2].log  # Примеры совпадений: access.0.log и access.1.log и access.2.log

file.[ac].out  # Примеры совпадений: file.a.out и file.b.out и file.c.out

file.[a-cx-z].out  # Примеры совпадений: file.a.out и file.b.out и file.c.out и file.x.out и file.y.out и file.z.out

access.[!0-2].log  # Примеры совпадений: access.3.log и access.4.log и access.Q.log

Символ !

! отменяет, или повторно включает любой файл, который игнорируется предыдущим шаблоном. Исключением из этого правила является повторное включение файла, если его родительский каталог исключен.

*.log 
!error.log
# error.log или logs/error.log не будут проигнорированы

Примеры шаблонов

Файлы из gitignore уже добавлены в репозиторий

Обратите внимание, что если файлы уже добавлены в git репозиторий, то добавление их в .gitignore не удалит эти файлы. Изменения в них будут продолжать отслеживаться и входить в коммиты, несмотря на то, что они есть в .gitignore. Нам придется вручную их удалить из репозитория.

Команда bash, которая удалит из git репозитория те файлы, которые содержатся в файлах .gitignore. При выполнении этой команды, файлы останутся у вас на диске, однако из репозитория они будут удалены:

git rm --cached `git ls-files -i --exclude-from=.gitignore`

Либо можно удалять файлы вручную, таким образом:

git rm --cached path/to/file

Если нужно удалить целую директорию из git, то воспользуемся следующей командой:

git rm  -r --cached path/to/directory

Параметр --cached означает, что файлы будут удалены только из раздела проиндексированных файлов. На диске, в рабочем каталоге они останутся нетронутыми.

Как понять почему игнорируется конкретный файл

Запустите команду вместо path/to/file следует указать путь к файлу, в итоге мы получим ответ в котором содержится конкретная строка .gitignore, благодаря которой данный файл игнорируется:

git check-ignore -v path/to/file

Отобразить все игнорируемые файлы:

git status --ignored

Очистить проект от всех игнорируемых файлов:

git clean -fX