git - 处理项目配置文件最简单的方法是什么？

Question

在任何项目中至少有一个配置文件是很常见的。每次我用 git 分享项目时，我都会遇到同样的问题:

• 敏感信息(每个开发者有不同的数据库密码等)
• 任务特定信息(当开发人员处理某些需要更改某些设置的任务时)

显然，必须以某种方式忽略配置，以防止开发人员特定数据淹没主存储库。现在有几种我曾经使用的方法，每种都有一些缺陷:

• .gitignore 配置文件
  • 最基本的方法
  • 当开发人员克隆 repo 时，配置文件丢失，必须找出重新创建配置的位置
• 配置文件不会被忽略。它包含一些虚拟信息，每个开发人员要么取消跟踪并将其放入他的 .git/info/exclude 中，要么将 git update-index --assume-unchanged ... 设置为文件
  • 文件可供克隆 repo 的任何人使用
  • 它包含的高级技术可能会让初次使用 git 的人感到困惑
  • 当有人意外提交配置文件时，它不会允许人们 pull/获取(因为排除与 .gitignore 的工作方式不同)
• 分发后缀为 _original 的配置文件，同时将真实文件放在 .gitignore 中。然后每个开发人员将文件重命名为真实姓名
  • 文件可供克隆 repo 的任何人使用
  • 必须在整个应用程序中搜索所有配置并重命名它们

有没有其他可能更好的方法来处理这个问题？我怀疑我遗漏了一些东西，至少是一些插件。

Answer 1

过滤器驱动程序是实现选项 3 的“自动”方式，详见“when you have secret key in your project, how can pushing to GitHub be possible?”:

smudge 脚本将在 checkout 时:

• 检测要修改的正确配置文件
• 获取所需信息(最好保存在任何 Git 存储库之外)并将模板值替换为实际值。

开发人员可以从那里对这些配置文件进行任何类型的修改。
没关系，因为 clean 脚本会在提交时将该文件的内容恢复为其原始(模板)值。没有意外推到那里。