.gitignore 用于 App.config 或 Web.config 中的连接字符串的最佳实践

Question

在大型团队工作时，我尝试了几种使用 *.gitignore 管理连接字符串的方法。

从gitignore 的.gitignore 文件的官方存储库中，我下载了VisualStudio.gitignore 并将其用作所有项目的起点。

同样的过程可以通过访问http://gitignore.io/，输入VisualStudio，然后下载文件来完成。

我目前使用的方法是利用SectionInformation.ConfigSource Property

<connectionStrings configSource="myConnectionStrings.config" />

然后将 myConnectionStrings.config 添加到 .gitignore，这很好，因为它不会添加整个 *.config。

您也可以在另一个项目（您的 MyProject.Data 层）中使用相同的 myConnectionStrings.config

<configuration>
  <connectionStrings configSource="myConnectionStrings.config"/>
</configuration>

记得设置始终复制！

我也尝试过使用filters ，如Git - Ignoring a specific modification to a config file 所述，但我发现这有点过头了。

我想知道是否还有其他被认为是最佳实践的方法？

Answer 1

我不能代表你的设置，但这就是我解决这个问题的方法。

首先，我团队中的所有人员都使用本地数据库，并将集成安全设置为 true。这意味着当我们从源代码管理中签出文件时，最好使用本地设置。所以我的 Web 配置文件看起来像这样

<add name="appConnString"
   connectionString="Data Source=(local);Initial Catalog=MyDatabaseName;Integrated Security=True;"
   providerName="System.Data.SqlClient" />

关于部署到不同的环境，您的第一个选择是使用转换。如果你不知道那是什么，read here

由于我们使用 Octopus Deploy 作为我们的部署工具，因此我们的转换文件具有“web.release.config”的连接字符串，如下所示

<add name="appConnString"
   connectionString="{{appConnString}}"
   xdt:Transform="Update" 
   xdt:Locator="Match(name)" />

当 Octopus 运行时，它会抓取 web.config 并使用发布文件覆盖相关部分。然后根据我要部署到的环境/机器/分支，它将 {{appConnString}} 替换为已为该部署设置的配置。

我确信 Visual Studio 的过程几乎相同。

如果您不喜欢转换过程。您还可以使用 parameters.xml 文件。 msdepoy 在构建时使用此文件替换 web.config 中的值。你可以阅读更多关于它的信息here。

另一个考虑因素是，如果您使用 Azure 进行托管，您可以在各种部署槽上设置某些配置替换，直至生产。

这些只是我使用过并看到非常有效使用的一些技术。有些人需要一点时间来适应，而且设置起来也很沮丧，但从长远来看，拥有一个合适的部署系统会有所回报。

Answer 2

也许有点自以为是，我认为不需要策略 来将shell glob 添加到文件中。在阅读此问题之前，我从未听说过“connectionStrings”，但据我所知，它们拥有各种后端的 URI / 凭据。

后端多久更换一次？更好的是，配置文件的路径多久更改一次？ 可能不够频繁，不足以保证政策。您唯一需要的是命名包含这些连接字符串的配置文件的约定，以便使用自动化工具轻松识别它们。

因此，请使用您的工具或编写脚本并将 <connectionStrings configSource="foobarService.config" /> 中的 foobarService.config 附加到所有后端的 .gitignore 文件中。

1。找到文件。

$ find -name cs.xml

./more/configs/here/cs.xml
./cs.xml
./some/sub/folder/cs.xml

2。获取配置文件名

$ find -name cs.xml | xargs grep -ho '[^"]\+\.config'

getImagesService.config
users.config
ldap.config
foobar2k.config
ratpoison.config
moo.config
foo.config
trololol.config
moreconfigz.config
myConnectionStrings.config
data.config
base.config
filebackend.config
offsitewhatever.config

3。忽略他们

$ find -name cs.xml | xargs grep -ho '[^"]\+\.config' >> .gitignore

4。更新你的简历

• 2014 年 3 月 - connectionString 策略的首席设计师

---

我很困惑，有人会询问有关管理 .gitignore 文件的建议。这可能表明我没有看到大局。您能否用一些背景信息更新您的问题？我很好奇为什么这是一个有意义的问题，因为我很难理解有必要建立最佳实践来将字符串附加到文件。