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

问题描述

我有一个settings.json文件,其中包含一堆有关我正在创建的应用程序的信息,包括usernamepassword。像这样:

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

我对软件开发非常陌生,尤其是制作开源应用程序并进行部署,因此我想知道在这种情况下的最佳实践。假设我要在GitHub上发布它,并且我希望settings.json也可以使用正确的结构但不包含我的私有数据。但是,我希望将其与数据一起放在本地,因为我将其用于测试。 我应该有两个文件,例如settings-local.jsonsettings-prod.json还是什么? 谢谢。

解决方法

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

在不同的环境中,拥有settings-ENVIRONMENT-NAME.json个文件。

settings-*添加到您的.gitignore文件中,以确保真实的凭据不会被意外发布。

包括明确的说明(例如在自述文件中),以说明如何命名实际设置文件。