Поддерживайте чистоту и безопасность своего репозитория с помощью этих советов и рекомендаций по .gitignore
Git — это мощная система контроля версий, которая помогает разработчикам управлять изменениями кодовой базы.
Однако мы можем счесть необходимым исключить определенные файлы или каталоги из отслеживания Git. Эти файлы могут содержать конфиденциальную информацию, такую как ключи API или учетные данные, или быть временными файлами, которые просто не нужны для контроля версий.
Здесь пригодится файл .gitignore. Из документации файл .gitignore указывает на намеренно неотслеживаемые файлы, которые Git должен игнорировать.
Здесь мы обсудим 7 советов по созданию и обслуживанию файла .gitignore.
1. Будьте проще
Первое и самое важное правило создания файла .gitignore — сделать его простым.
Файл .gitignore должен включать только те файлы и каталоги, которые мы хотим исключить из отслеживания Git. Избегайте включения ненужных файлов и каталогов, так как это может загромождать ваш файл .gitignore, что затруднит его обслуживание.
2. Используйте подстановочные знаки
Git поддерживает подстановочные знаки * в .gitignore файлах. Использование подстановочного знака позволяет нам более легко и лаконично исключать несколько файлов с одинаковым расширением или каталогов с похожими именами.
Например, мы можем использовать подстановочный знак, чтобы исключить все файлы с определенным расширением, например .xlsx:
## example ignore all Excel files *.xlsx
3. Игнорировать временные файлы
Для языков программирования и фреймворков характерно создание временных файлов во время разработки, таких как файлы журнала и кэша.
Эти файлы могут быстро загромождать наш репозиторий и затруднить отслеживание изменений.
Рекомендуется исключить временные файлы из списка, отслеживаемого Git.
4. Исключите конфиденциальные данные
Важно, чтобы Git не отслеживал любые конфиденциальные данные и конфиденциальную информацию, включая ключи API, пароли и закрытые ключи.
Эти файлы никогда не следует помещать в репозиторий Git, даже в частный, поскольку они могут быть скомпрометированы в случае утечки или взлома репозитория.
Вместо этого используйте переменные среды или другие безопасные методы для хранения данных такого типа.
5. Используйте комментарии
Строки, начинающиеся с #, являются комментариями.
Добавление комментариев к нашему gitignore может помочь нам и другим разработчикам быстро понять, какие именно файлы игнорируются.
# Ignore file containing environment variables and credentials .env
Добавление комментариев с объяснением игнорирования определенных файлов также может быть полезным, особенно если мы игнорируем то, что обычно отслеживается.
6. Воспользуйтесь преимуществами шаблонов .gitignore
GitHub поддерживает коллекцию .gitignore шаблонов. Эти шаблоны доступны в раскрывающемся списке при создании нового репозитория.
Если вы не уверены, какие именно типы файлов игнорировать, эти шаблоны — отличное место для начала. После выбора шаблона на основе нашего основного языка кодирования для проекта мы можем обновить наш .gitignore, если это необходимо.
7. Регулярно просматривайте и обновляйте свой .gitignore
По мере развития вашего проекта файлы и каталоги, которые необходимо исключить из Git, могут измениться.
Важно регулярно просматривать и обновлять файл .gitignore, чтобы он оставался актуальным и эффективным. Это поможет предотвратить отслеживание ненужных файлов и повысит общую эффективность вашей системы контроля версий.
Заключение
В заключение, создание и обслуживание файла .gitignore является важной передовой практикой для каждого разработчика, использующего Git.
Следуя этим рекомендациям, мы можем гарантировать, что наши репозитории останутся организованными, безопасными и эффективными.
Дополнительные материалы на PlainEnglish.io.
Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter, LinkedIn, YouTube и Discord .
Заинтересованы в масштабировании запуска вашего программного обеспечения? Ознакомьтесь с разделом Схема.
