Quel est le meilleur moyen de gérer les fichiers de configuration avec git?

Question

Disons que mon application contient des fichiers de configuration en texte brut. Ils contiennent des informations sensibles nécessaires au test de l'application dans mon environnement de développement. J'utilise différents systèmes d'exploitation pour accéder à mes projets et travailler sur ceux-ci (Win, Mac, ...).

Je ne souhaite pas qu'une partie des informations contenues dans les fichiers de configuration parvienne dans mon référentiel git public. Dans le meilleur des cas, je souhaite que les informations sensibles soient remplacées par des espaces réservés et que les fichiers de configuration soient téléchargés dans le référentiel afin de suivre leur structure.

Comment aborderiez-vous le problème?

Le crochet lui-même ne serait pas un problème pour moi d’écrire. Je suis plus intéressé par la manière de lier le tout, la structure de répertoires possible, etc. Je suis assez nouveau pour git.

Answer 1

Vous pouvez utiliser une convention suivie dans le monde Django: il existe un fichier standard settings.py qui importe un module local_settings à la fin s'il en existe un de disponible.

Ayez toutes vos informations secrètes dans ce fichier local_settings.py et ajoutez-les à .gitignore afin qu'elles ne soient pas vers le référentiel. Ainsi, les utilisateurs sauront qu’ils peuvent ajouter leurs propres paramètres à <=>.

Par exemple,

<=>:

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

<=>:

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

La meilleure partie est que tout ce que vous avez défini dans <=> sera remplacé par le même nom dans <=>.