在没有私人数据的情况下发布设置的最佳做法是什么？

Question

我有一个 settings.json 文件，其中包含大量信息，包括我正在创建的应用程序的 username 和 password。类似于：

{
    "application": {
        "username": "someuser",
        "password": "somepassword",
    }
}

我对软件开发相当陌生，尤其是制作开源应用程序和部署它们，所以我想知道在这种情况下最佳实践是什么。假设我在 GitHub 上发布它，我希望 settings.json 也可用，并且结构正确但不包含我的私人数据。但是，我想将它与数据一起保存在本地，因为我将它用于测试。我应该有两个文件 settings-local.json 和 settings-prod.json 还是什么？谢谢。

Answer 1

有一个 example-settings.json 文件，其中包含虚拟数据。

拥有与不同环境一样多的 settings-ENVIRONMENT-NAME.json 个文件。

将 settings-* 添加到您的 .gitignore 文件中，这样真实的凭据就不会被意外发布。

包含关于如何命名真实设置文件的明确说明（例如在您的自述文件中）。

在没有私人数据的情况下发布设置的最佳做法是什么？

What is the best practice for publishing settings without private data?

json

github

private-key