Каков наилучший способ обработки файлов конфигурации с помощью git?

Question

Скажите, что мое приложение имеет файлы конфигурации в виде простого текста. Они содержат некоторую конфиденциальную информацию, которая требуется для тестирования приложения в моей среде разработки. Я использую разные ОС для доступа и работы над своими проектами (win, mac, ...).

Я не хочу, чтобы некоторая информация в файлах конфигурации попала в мой общедоступный репозиторий git. В лучшем случае я хочу, чтобы конфиденциальная информация была заменена заполнителями, и чтобы файлы конфигурации были загружены в хранилище для отслеживания их структуры.

---

Как бы вы подошли к проблеме?

Сам по себе хук не будет большой проблемой для меня. Меня больше интересует, как все это связать, возможная структура каталогов и т. Д. Я совершенно новичок в git.

Answer 1

В мире Django существует соглашение, которое вы можете использовать - есть стандартный файл settings.py, который импортирует модуль local_settings в конце, если он есть.

Храните все свои секретные материалы в этом local_settings.py файле и добавьте его в .gitignore, чтобы он не попадал в хранилище. Таким образом, люди будут знать, что они могут добавить свои собственные настройки в local_settings.

Например,

settings.py:

DATABASE_USERNAME = 'your username here'
DATABASE_PASSWORD = 'your password here'

local_settings.py

DATABASE_USERNAME = 'my top secret username'
DATABASE_PASSWORD = 'my top secret password'

Самое приятное, что все, что вы определили в settings.py, будет переопределено с тем же именем в local_settings.py.