使用MSBuild批量重命名

Question

我刚刚加入了一个没有CI流程的团队(甚至没有过夜构建)和一些粗略的开发实践.有改变这一点的愿望,所以我现在的任务是创建一个过夜构建.我已经跟着这一系列文章:创建一个包含我们所有项目的主解决方案(一些Web应用程序,一个Web服务,一些Windows服务,以及编译成命令行可执行文件的几个关闭工具); 创建了一个MSBuild脚本来自动构建,打包和部署我们的产品; 并创建了一个.cmd文件,只需单击一下即可完成.这是我现在要完成的一项任务,作为所有这一切的一部分:

该团队目前的做法是将web.config和app.config文件保留在源代码控制之外,并放入名为web.template.config和app.template.config的源代码控制文件中.目的是开发人员将.template.config文件复制到.config以获取所有标准配置值,然后能够将.config文件中的值编辑为本地开发/测试所需的任何值.出于显而易见的原因,我想自动将.template.config文件重命名为.config.最好的方法是什么？

是否可以在构建脚本本身中执行此操作,而无需在脚本中规定需要重命名的每个单独文件(在将新项目添加到解决方案时需要对脚本进行维护)？或者我可能要写一些我只是从脚本运行的批处理文件？

此外,是否有一个更好的开发解决方案,我可以建议,这将使整个过程不必要？

Answer 1

经过大量关于项目组,目标和复制任务的阅读后,我已经找到了如何做我需要的东西.

<ItemGroup>
    <FilesToCopy Include="..\**\app.template.config">
        <NewFilename>app.config</NewFilename>
    </FilesToCopy>
    <FilesToCopy Include="..\**\web.template.config">
        <NewFilename>web.config</NewFilename>
    </FilesToCopy>
    <FilesToCopy Include"..\Hibernate\hibernate.cfg.template.xml">
        <NewFilename>hibernate.cfg.xml</NewFilename>
    </FilesToCopy>
</ItemGroup>

<Target Name="CopyFiles"
        Inputs="@(FilesToCopy)"
        Outputs="@(FilesToCopy->'%(RootDir)%(Directory)%(NewFilename)')">
    <Message Text="Copying *.template.config files to *.config"/>
<Copy SourceFiles="@(FilesToCopy)"
      DestinationFiles="@(FilesToCopy->'%(RootDir)%(Directory)%(NewFilename)')"/>

我创建了一个包含我要复制的文件的项目组.**运算符告诉它递归整个目录树以查找具有指定名称的每个文件.然后,我为每个名为"NewFilename"的文件添加一段元数据.这就是我将每个文件重命名为.

此代码段添加名为app.template.config的目录结构中的每个文件,并指定我将命名新文件app.config:

<FilesToCopy Include="..\**\app.template.config">
    <NewFilename>app.config</NewFilename>
</FilesToCopy>

然后我创建一个目标来复制所有文件.此目标最初非常简单,只调用复制任务以便始终复制和覆盖文件.我将FilesToCopy项目组作为复制操作的来源传递.我使用转换来指定输出文件名,以及我的NewFilename元数据和众所周知的项元数据.

以下代码片段将例如将文件c:\ Project\Subdir\app.template.config转换为c:\ Project\Subdir\app.config并将前者复制到后者:

<Target Name="CopyFiles">
    <Copy SourceFiles="@(FilesToCopy)"
          DestinationFiles="@(FilesToCopy->'%(RootDir)%(Directory)%(NewFileName)')"/>
</Target>

但后来我注意到,开发人员可能不喜欢每次运行脚本时都会覆盖自定义的web.config文件.但是,如果存储库的web.template.config已被修改,开发人员可能应该覆盖其本地文件,现在其中包含代码所需的新值.我尝试了许多不同的方法 - 使用"Exist()"函数将Copy属性"SkipUnchangedFiles"设置为true - 无济于事.

解决方案是逐步建立.这可确保只有app.template.config更新时才会覆盖文件.我将文件的名称作为目标输入传递,并将新文件名指定为目标输出:

<Target Name="CopyFiles"
        Input="@(FilesToCopy)"
        Output="@(FilesToCopy->'%(RootDir)%(Directory)%(NewFileName)')">
      ...
</Target>

这具有目标检查以查看当前输出是否相对于输入是最新的.如果不是,即特定的.template.config文件具有比其对应的.config文件更新的更新,则它将通过现有的web.config复制web.template.config.否则,它将单独保留开发人员的web.config文件并且不进行修改.如果不需要复制任何指定的文件,则完全跳过目标.在清理存储库克隆之后,将立即复制每个文件.

以上结果是一个令人满意的解决方案,因为我刚刚开始使用MSBuild,我对其强大的功能感到惊讶.我唯一不喜欢的是我必须在两个地方重复完全相同的变换.我讨厌复制任何类型的代码,但我无法弄清楚如何避免这种情况.如果有人有小费,我们将不胜感激.此外,虽然我认为开发实践需要完全糟糕,但这确实有助于减轻这个吸引因素.