Файл.gitignore
используется для указания, какие файлы не надо отслеживать системой контроля версий Git.
Игнорируемые файлы — это, как правило, артефакты сборки и файлы, генерируемые машиной из исходных файлов в вашем репозитории, либо файлы, которые по какой-либо иной причине не должны попадать в коммиты.
- , который содержит пользовательские настройки внешнего вида и отображения папок, такие как размер и положение иконок.Файлы операционной системы. Каждая операционная система, будь то macOS, Windows или Linux, создает системные скрытые файлы, которые не нужны другим разработчикам, так как их система создает такие же файлы. Например, в macOS Finder создает файл.DS_Store
- .Файлы конфигурации, создаваемые такими приложениями, как редакторы кода и IDE. Эти файлы настроены под вас, ваши конфигурации и ваши настройки, например папка.idea
- .Файлы, которые автоматически генерируются языком программирования или средой разработки, которую вы используете для своего проекта, и в процессе компиляции специфичных для кода файлов, такие как файлы*.pyc
- . Это папка, которая используется для сохранения зависимостей проекта.Папки с виртуальным окружениемvenv
или.venv - (содержат ключи API, которые должны оставаться защищенными и закрытыми).Файлы, которые содержат конфиденциальные данные и личную информацию. Примерами таких файлов могут послужить файлы с вашими учетными данными (имя пользователя и пароль) и файлы с переменными среды, такие как файлы.env
- . Они предоставляют информацию об использовании операционной системы и ошибках, а также историю событий, произошедших в рамках ОС.Файлы среды выполнения, такие как файлы.log
Файл
.gitignore
используется для указания, какие файлы не надо отслеживать системой контроля версий Git. Его можно создать самостоятельно или скопировать стандартные
.gitignore
файлы для Python-проектов, например тут (не забудьте раскомментировать последнюю строчку в
.idea
, если пользуетесь PyCharm)
Файл
.gitignore
может содержать шаблоны, которые сопоставляются с именами файлов в репозитории, чтобы определить, необходимо ли игнорировать эти файлы.
Примеры шаблонов:
- — игнорируются каталоги и файлы с именем venv.venv
- — игнорируется содержимое любого каталога с именем venv.venv/
- — игнорируется debug.log в корне, но не в любом другом каталоге./debug.log
- — игнорируются все файлы с расширением .pyc.*.pyc
- — игнорируются все файлы с расширением .log.*.log
- — игнорируются все логи, кроме debug.log.!debug.log
Пример содержания файла
.gitignore
:
venv/
.idea/
__pycache__/
*.pyc
Возможные ситуации при работе с файлами:
- , то в этом случае достаточно удалить файл (или файлы) из индекса.Если файл добавлен в индекс и этот же файл надо игнорировать, т. е. его шаблон есть в.gitignore
- .Чтобы игнорировать файл, для которого ранее был сделан коммит, необходимо удалить этот файл из репозитория, а затем добавить для него правило в.gitignore
В обоих случаях используйте команду удаления из индекса и коммита, но не физическое удаление файла с диска:
git rm --cached <file-name>
