Для чего используется файл gitignore
.gitignore
Git рассматривает каждый файл в вашей рабочей копии как файл одного из трех нижеуказанных типов.
Игнорируемые файлы — это, как правило, артефакты сборки и файлы, генерируемые машиной из исходных файлов в вашем репозитории, либо файлы, которые по какой-либо иной причине не должны попадать в коммиты. Вот некоторые распространенные примеры таких файлов:
Шаблоны игнорирования в Git
| Шаблон | Примеры соответствия | Пояснение* |
|---|---|---|
| **/logs | logs/debug.log logs/monday/foo.bar build/logs/debug.log | Добавьте в начало шаблона две звездочки, чтобы сопоставлять каталоги в любом месте репозитория. |
| **/logs/debug.log | logs/debug.log build/logs/debug.log но не logs/build/debug.log | Две звездочки можно также использовать для сопоставления файлов на основе их имени и имени родительского каталога. |
| *.log | debug.log foo.log .log logs/debug.log | Одна звездочка — это подстановочный знак, который может соответствовать как нескольким символам, так и ни одному. |
| *.log !important.log | debug.log trace.log но не important.log logs/important.log | Добавление восклицательного знака в начало шаблона отменяет действие шаблона. Если файл соответствует некоему шаблону, но при этом также соответствует отменяющему шаблону, указанному после, такой файл не будет игнорироваться. |
| *.log !important/*.log trace.* | debug.log important/trace.log но не important/debug.log | Шаблоны, указанные после отменяющего шаблона, снова будут помечать файлы как игнорируемые, даже если ранее игнорирование этих файлов было отменено. |
| /debug.log | debug.log но не logs/debug.log | Косая черта перед именем файла соответствует файлу в корневом каталоге репозитория. |
| debug.log | debug.log logs/debug.log | По умолчанию шаблоны соответствуют файлам, находящимся в любом каталоге |
| debug?.log | debug0.log debugg.log но не debug10.log | Знак вопроса соответствует строго одному символу. |
| debug3.log | debug0.log debug1.log но не debug10.log | Квадратные скобки можно также использовать для указания соответствия одному символу из заданного диапазона. |
| debug[01].log | debug0.log debug1.log но не debug2.log debug01.log | Квадратные скобки соответствуют одному символу из указанного набора. |
| debug[!01].log | debug2.log но не debug0.log debug1.log debug01.log | Восклицательный знак можно использовать для указания соответствия любому символу, кроме символов из указанного набора. |
| debug[a-z].log | debuga.log debugb.log но не debug1.log | Диапазоны могут быть цифровыми или буквенными. |
| logs | logs logs/debug.log logs/latest/foo.bar build/logs build/logs/debug.log | Без косой черты в конце этот шаблон будет соответствовать и файлам, и содержимому каталогов с таким именем. В примере соответствия слева игнорируются и каталоги, и файлы с именем logs |
| logs/ | logs/debug.log logs/latest/foo.bar build/logs/foo.bar build/logs/latest/debug.log | Косая черта в конце шаблона означает каталог. Все содержимое любого каталога репозитория, соответствующего этому имени (включая все его файлы и подкаталоги), будет игнорироваться |
| logs/ !logs/important.log | logs/debug.log logs/important.log | Минуточку! Разве файл logs/important.log из примера слева не должен быть исключен нз списка игнорируемых? Нет! Из-за странностей Git, связанных с производительностью, вы не можете отменить игнорирование файла, которое задано шаблоном соответствия каталогу |
| logs/**/debug.log | logs/debug.log logs/monday/debug.log logs/monday/pm/debug.log | Две звездочки соответствуют множеству каталогов или ни одному. |
| logs/*day/debug.log | logs/monday/debug.log logs/tuesday/debug.log but not logs/latest/debug.log | Подстановочные символы можно использовать и в именах каталогов. |
| logs/debug.log | logs/debug.log но не debug.log build/logs/debug.log | Шаблоны, указывающие на файл в определенном каталоге, задаются относительно корневого каталога репозитория. (При желании можно добавить в начало косую черту, но она ни на что особо не повлияет.) |
Персональные правила игнорирования в Git
Глобальные правила игнорирования в Git
Игнорирование ранее закоммиченного файла
Коммит игнорируемого файла
Этот способ хорош, если у вас задан общий шаблон (например, *.log ), но вы хотите сделать коммит определенного файла. Однако еще лучше в этом случае задать исключение из общего правила:
Этот подход более прозрачен и понятен, если вы работаете в команде.
Скрытие изменений в игнорируем файле
При желании команде git check-ignore можно передать несколько имен файлов, причем сами имена могут даже не соответствовать файлам, существующим в вашем репозитории.
Готовы изучить Git?
Ознакомьтесь с этим интерактивным обучающим руководством.
В большинстве проектов есть разница между кодом / конфигурацией и сгенерированные файлы из этого кода или конфигурации. Последнее обычно бесполезно, и его можно игнорировать.
Обычно вы хотите, чтобы код и конфигурация отслеживались только через git. Это связано с тем, что сгенерированные файлы эфемерны, и если вы удалите их, вы можете просто восстановить их снова. Часто нет смысла загружать их, поскольку они просто усложнят ситуацию и вызовут ненужные конфликты слияния.
Это широкое определение, поэтому давайте рассмотрим пример. В проектах Node JS есть папка с именем node_modules, которая содержит все внешние пакеты, которые необходимо запустить вашему коду. Вы можете удалить этот каталог и полностью перестроить его, запустив команду npm install, которая использует конфигурацию package.json для поиска пакетов.
Так какой смысл иметь папку node_modules в Git? На самом деле его нет, так как он более сложный, может вызвать проблемы и даже во многих случаях может значительно увеличить размер репозитория Git.
Вы можете настроить это разными способами, но основные инструменты, которые у вас есть:
Например, Node JS gitignore может выглядеть следующим образом:
Добавление файлов в белый список с помощью! может быть очень полезным для многих конфигураций. Например, в одном из моих проектов у меня был инструмент steamcmd, который загружает зависимости для игровых серверов из Steam. Этот инструмент упакован в один переносимый исполняемый файл, но он производит огромное количество мусора, который я не хочу отслеживать в Git.
Решением было игнорировать все в папке, но занести исполняемый файл в белый список. Это будет работать для любого переносимого исполняемого файла, который расширяется таким образом или создает в каталоге ненужный мусор.
Проект / steamcmd / **! Project / steamcmd / steamcmd.exe
gitignore также использует некоторые другие Unix шарик шаблоны для сопоставления строк, например вопросительный знак для сопоставления одного символа или [a-z] который будет соответствовать наборам символов.
# Результаты сборки
[Dd]ebug /
[Dd]ebugPublic /
[Rr]elease /
[Rr]eleases /
Если вы все равно хотите установить его, вы можете сделать это с помощью следующей команды:
git config —global core.excludesfile
Принудительная фиксация или сохранение игнорируемых файлов
Принудительная фиксация, как правило, плохая идея — вам, вероятно, следует добавить белый список для этого конкретного файла, потому что после фиксации обновления этого файла не будут отслеживаться. Но если вы хотите что-то зафиксировать вручную, вы можете запустить git add с параметром —force:
Точно так же git stash также может хранить локальные изменения в игнорируемых файлах, что на самом деле может быть полезно, поскольку не повлияет на удаленное репо:
Что такое файл GITIGNORE?
Как открыть, редактировать и конвертировать файлы GITIGNORE
Файл с расширением GITIGNORE представляет собой файл Git Ignore, используемый в системе контроля версий/исходных кодов под названием Git. Он указывает, какие файлы и папки не следует игнорировать в данном исходном коде.
Его можно использовать отдельно для каждого пути, чтобы правила применялись только к определенным папкам, но вы также можете создать глобальный файл GITIGNORE, который применяется к каждому имеющемуся хранилищу Git.
Как открыть файл GITIGNORE
Файлы GITIGNORE представляют собой простые текстовые файлы, то есть вы можете открыть их с помощью любой программы, которая может читать текстовые файлы.
Пользователи Windows могут открывать файлы GITIGNORE с помощью встроенной программы Notepad или бесплатного приложения Notepad ++. Чтобы открыть файлы GITIGNORE в macOS, вы можете использовать Gedit. Пользователи Linux (а также Windows и macOS) могут найти Atom полезным для открытия и редактирования файлов GITIGNORE.
Однако файлы GITIGNORE фактически не могут использоваться (то есть они не функционируют как файл игнорирования), если они не используются в контексте Git, который является бесплатным программным обеспечением, работающим в Windows, Linux и macOS.
Вы можете использовать файл GITIGNORE, разместив его там, где вы хотите, чтобы правила применялись. Поместите разные в каждый рабочий каталог, и правила игнорирования будут работать для каждой папки отдельно. Если вы поместите файл GITIGNORE в корневую папку рабочего каталога проекта, вы можете добавить туда все правила, чтобы он играл глобальную роль.
Не помещайте файл GITIGNORE в каталог репозитория Git; это не позволит применять правила, поскольку файл должен находиться в рабочем каталоге.
Файлы GITIGNORE полезны для обмена правилами игнорирования со всеми, кто может клонировать ваш репозиторий. Вот почему, согласно GitHub, важно добавить его в свой репозиторий.
Как конвертировать в/из файла GITIGNORE
См. Этот поток переполнения стека для получения информации о преобразовании CVSIGNORE в GITIGNORE. Простой ответ заключается в том, что не существует обычного конвертера файлов, который мог бы сделать это за вас, но может существовать сценарий, который вы можете использовать для копирования шаблонов файла CVSIGNORE.
Посмотрите, Как Преобразовать Репозитории SVN в Репозитории Git для помощи, делающей это. Также посмотрите этот скрипт Bash, который может достичь того же.
Чтобы сохранить файл GITIGNORE в формате текстового файла, используйте один из текстовых редакторов, упомянутых выше. Большинство из них могут конвертировать в TXT, HTML и аналогичные форматы простого текста.
Расширенное чтение файлов GITIGNORE
Вы можете создать локальный файл GITIGNORE из терминала с помощью этой команды:
Глобальный можно сделать так:
Вот простой пример файла GITIGNORE, который игнорирует различные файлы, сгенерированные операционной системой:
Вот пример GITIGNORE, который исключает файлы LOG, SQL и SQLITE из исходного кода:
Существует множество шаблонных правил, которые необходимо соблюдать, чтобы соблюсти правильные синтаксические правила, требуемые Git. Вы можете прочитать об этом и многом другом о том, как работает файл, на официальном сайте документации GITIGNORE.
Обязательно помните, что если вы уже отметили файл, чтобы его не игнорировать, а затем добавьте правило игнорирования для него в файл GITIGNORE, Git не будет игнорировать файл, пока вы не отследите его с помощью следующей команды:
Ваш файл все еще не открывается?
Если ваш файл не работает, как описано выше, убедитесь, что вы правильно читаете расширение файла. Например, если вы не можете открыть его в текстовом редакторе или Git не распознает файл, вы, возможно, не имеете дело с файлом GITIGNORE.
IGN – это еще один файл игнорирования, но в формате файла списка игнорирования RoboHelp, созданный и используемый вместе с Adobe RoboHelp для создания справочных документов Windows. Хотя файл может выполнять аналогичную функцию – выводить список слов, которые игнорируются при поиске в документации, – он не может использоваться с Git и не следует тем же правилам синтаксиса.
Если ваш файл не открывается, изучите его расширение, чтобы узнать, в каком формате он находится, чтобы найти соответствующее программное обеспечение, которое открывает или конвертирует его.
Содержание
.gitignore служит для указания в нём файлов и папок, которые необходимо скрыть от системы контроля версий git.
Как правило, скрывают файлы или папки, которые автоматически генерируют своё содержимое, либо имеют конфигурационные параметры, которые могут различаться у тех, кто совместно работает над проектом.
Приведу простой пример: у вас имеется файл «/config/db.php«, в нём прописаны параметры подключения к БД, причём на вашей локальной машине и на сервере эти параметры будут разниться. А если эти файлы различны, то git будет при каждом pull/push ругаться на то, что имеется конфликт.
Другой пример: если вы используете NetBeans и настройки своего проекта храните непосредственно в папке с проектом, то вам необходимо закрыть от git`а директорию «nbproject«, чтобы другие участники вашего проекта не страдали от того, что вы случайно закомитили эту директорию.
Данная ситуация легко разрешатся использованием файла .gitignore, который можно разместить в папке «/config/.gitignore» со следующим содержимым:
Одна эта строчка укажет git, что необходимо игнорировать файл » db.php«, который лежит в этой директории.
Вот некоторые правила синтаксиса этого файла:
У некоторых может возникнуть вопрос:
Ответ таков: Нужно удалить из репозитория игнорируемые файлы/директории, делается это командой. После этого файл окончательно пропадёт из отслеживаемых git`ом.
Для чего используется файл gitignore
Часто при работе над проектом, использующим Git, вы хотите исключить передачу определенных файлов или каталогов в удаленный репозиторий.
Какие файлы следует игнорировать?
Игнорируемые файлы обычно представляют собой файлы, специфичные для платформы, или автоматически созданные из сборочных систем. Ниже приводятся некоторые общие примеры:
.gitignore использует glob шаблоны для сопоставления имен файлов с символами подстановки (Это что-то вроде регулярных выражений). Если у вас есть файлы или каталоги, содержащие шаблон подстановки (например * ), вы можете использовать один обратный слеш ( \* ), чтобы экранировать такой символ.
Комментарии
Строки, начинающиеся со знака хэша (# ), являются комментариями и игнорируются. Пустые строки могут быть использованы для улучшения читабельности файла и группировки связанных строк шаблонов.
Если шаблон не начинается со слэша, он соответствует файлам и каталогам в любом каталоге или подкаталоге.
Если шаблон заканчивается косой чертой, то он соответствует только каталогам. Когда каталог игнорируется, все его файлы и подкаталоги также игнорируются.
Имена файлов
| Шаблон | Примеры совпадений |
|---|---|
| /access.log | access.log |
| access.log | access.log logs/access.log var/logs/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.1.log | access.0.log access.1.log access.2.log |
| file.[a-c].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 or logs/error.log will not be ignored |
Персональные правила игнорирования
Файл может называться по вашему усмотрению и храниться в любом месте. Наиболее распространенным местом хранения этого файла является домашний каталог. Вам придется вручную создать файл и настроить Git для его использования.
Например, чтобы установить
/.gitignore_global в качестве глобального файла игнорирования Git, выполните следующие действия:
2. Добавьте этот файл в Git-конфигурацию:
3. Откройте файл в текстовом редакторе и добавьте в него свои правила.
Глобальные правила особенно полезны при игнорировании определенных файлов, которые вы никогда не захотите фиксировать, таких как файлы с конфиденциальной информацией или скомпилированные исполняемые файлы.
Игнорирование ранее зафиксированных файлов
Файлы в вашей рабочей копии могут отслеживаться или не отслеживаться.
Например, чтобы проверить, почему файл www/yarn.lock игнорируется, нужно выполнить следующее:
На выходе отображается путь к файлу игнорирования, номер соответствующей линии и фактический шаблон.
Команда также принимает в качестве аргументов более одного имени файла, и файл не обязательно должен существовать в рабочем дереве.