在 TFS 2010 或 msbuild 中触发配置转换

Question

我正在尝试使用配置转换 在持续集成环境中。

我需要一种方法来告诉 TFS 构建代理执行转换。我有点希望它能在发现配置转换文件（web.qa-release.config、web.product-release.config 等）后起作用。但事实并非如此。

我有一个 TFS 构建定义，可以构建正确的配置（qa 发布、生产发布等），并且我有一些在这些定义中构建的特定 .proj 文件，并且这些文件包含一些特定于环境的参数，例如：

<PropertyGroup Condition=" '$(Configuration)'=='production-release' ">
    <TargetHost Condition=" '$(TargetHost)'=='' ">qa.web</TargetHost>
    ...
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)'=='qa-release' ">
    <TargetHost Condition=" '$(TargetHost)'=='' ">production.web</TargetHost>
    ...
</PropertyGroup>

我知道从输出中可以看出正在构建正确的配置。现在我只需要学习如何触发配置转换。是否有一些诡计可以添加到构建中的最终 .proj 中以启动转换并消除各个转换文件？

Answer 1

我找到了另一种方法来完成此任务，而不是创建自定义活动。您只需要修改正在构建的Web应用程序的Visual Studio项目文件。

添加以下内容（可以在项目文件末尾找到“AfterBuild”目标的占位符）：

<Target Name="AfterBuild" Condition="$(IsAutoBuild)=='True'"> 
  <ItemGroup> 
         <DeleteAfterBuild Include="$(WebProjectOutputDir)\Web.*.config" /> 
  </ItemGroup> 
  <TransformXml Source="Web.config" Transform="$(ProjectConfigTransformFileName)" Destination="$(WebProjectOutputDir)\Web.config"/> 
  <Delete Files="@(DeleteAfterBuild)" />
</Target> 

然后您只需将 /p:IsAutoBuild="True" 添加到“MSBuild Arguments” ' 字段位于构建定义的“高级”部分。

当 TFS 进行构建时，这将强制 TFS 2010 在 web.config 上进行转换。

更多详细信息，请访问 Kevin Daly 的博客。

Answer 2

我终于成功地让这个工作了。我正在使用 TFS 2008，但也使用 MSBuild 4.0，因此它应该适合您。

首先，将此导入添加到 TFSBuild.proj：

<Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\WebApplications\Microsoft.WebApplication.targets" />

接下来，添加 BeforeDropBuild 目标：

<Target Name="BeforeDropBuild">
  <TransformXml Source="$(SolutionRoot)\MySite\Web.config"
    Transform="$(SolutionRoot)\MySite\Web.QA.config"
    Destination="$(OutDir)\_PublishedWebsites\MySite\Web.QA.config.transformed" />
</Target>

然后您可以将 Web.QA.config.transformed 复制到您需要的任何位置。

Answer 3

默认情况下，对于命令行和 TFS 构建，禁用添加到 Visual Studio 2010 中网站项目的 web.config 转换功能。

有两种相对简单的解决方案：

选项 1：编辑构建定义并将以下内容添加到“MSBuild Arguments”字段：

/p:UseWPP_CopyWebApplication=true /p:PipelineDependsOnBuild=false

UseWPP_CopyWebApplication 将导致为构建激活新的 Web 发布管道 (WPP) 。 WPP 执行 web.config 转换，还可以用于阻止将 .PDB 文件等内容复制到 bin 文件夹。

选项 2：MSBuild 和 WPP 都是完全可扩展的。在与项目相同的目录中创建一个新的 XML 文件，并使用“.targets”扩展名 - 例如 ProjectName.custom.targets。将以下 MSBuild 代码放入目标文件中：

<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <UseWPP_CopyWebApplication>True</UseWPP_CopyWebApplication>
    <PipelineDependsOnBuild>False</PipelineDependsOnBuild>
  </PropertyGroup>
</Project>

右键单击您的网站并选择“卸载项目”。右键单击卸载的项目并选择编辑。滚动到项目文件的底部并查找这些行：

<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\WebApplications\Microsoft.WebApplication.targets" />

这些行是 C# 和 Web 项目构建过程连接的地方。在 CSharp 导入之前立即插入自定义构建扩展（目标文件）的导入：

<Import Project="ProjectName.custom.targets"/>
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\WebApplications\Microsoft.WebApplication.targets" />

就是这样 - 一切顺利。 MSBuild 自定义方法的设置工作较多，但好处是您可以使用新的目标文件“挂钩”到构建过程，并对构建在服务器上的发生方式有更多控制。例如，您可以挂钩任务来执行 CSS 和 JS 压缩。

我还建议查看“wpp 目标” - 如果您使用特定名称“ProjectName.wpp.targets”命名另一个 MSBuild 文件，您可以控制整个网站发布过程。我们使用它来删除 -vsdoc javascript 文档文件，因为已发布的网站输出被复制：

<ItemGroup>
  <ExcludeFromPackageFiles Include="Scripts\**\*-vsdoc.js;Resources\Scripts\**\-vsdoc.js">
    <FromTarget>Project</FromTarget>
  </ExcludeFromPackageFiles>
</ItemGroup>

综上所述，您最好完全从构建中删除生产 web.configs。我们将转换直接放置到生产部署机器上，并在部署应用程序时使用 powershell 进行转换。

Answer 4

这是一个更简单的答案。 :)

http://social.msdn.microsoft .com/Forums/en-US/tfsbuild/thread/d5c6cc7b-fbb1-4299-a8af-ef602bad8898/

从链接（如果它被移动/404/等）：

这是我解决这个问题的方法。关键
是编辑 *.csproj 文件
网站并将以下内容添加到
AfterBuild 目标（确保将
上面的评论结束）。这是为了
我们在团队中的网站建设项目
基础服务器。

<目标名称=“AfterBuild”>
    

要保留 web.debug.config，
web.release.config 等...从
发布时一定要设置“Build
属性窗口中的“操作”
每个配置转换
文件设置为“无”。仅主要
web.config 应该有一个“构建
“内容”的“操作”

编辑 csproj 文件的一种简单方法
是加载“PowerCommands
对于 Visual Studio 2010”或
“生产力电动工具”扩展
Visual Studio 2010 可从
Visual Studio 画廊。一次
加载你所要做的一切都是对的
单击解决方案中的项目
并选择“卸载项目”。然后你
可以再次右键单击并选择
“编辑...”编辑 csproj 文件 XML
直接地。然后当做得恰到好处时
再次单击并选择“重新加载
项目”。

Answer 5

您需要做的就是设置应在 TFS 构建定义中使用哪些配置。

1. 转到团队资源管理器>构建
2. 编辑构建定义（或创建新定义）
3. 在“处理”步骤下，有一个“构建配置”的设置。

就我而言，我专门为 CI 设置了一个配置，然后执行正确的 web.config 转换。确保您已添加“CI”转换文件，然后就可以开始了。

Answer 6

要在工作流中执行此操作，您必须创建一个自定义活动。有一篇关于它的很好的文章 此处

对于此特定活动，您需要创建活动项目（将其从.Net 4 客户端配置文件更改为 .Net 4）并引用 GAC 中的 Microsoft.Build.Framework 和 Microsoft.Build.Utilities.v4.0，然后引用 Microsoft.Web来自 %programfiles%\msbuild\Microsoft\VisualStudio\v10.0\WebApplications 的.Publishing.Tasks（如果您使用的是 64 位系统，则为 %programfiles(x86)%）。

完成后，您添加这两个类：

首先，有一个存根：

internal class BuildEngineStub : IBuildEngine
{
    public bool BuildProjectFile(string projectFileName, string[] targetNames, System.Collections.IDictionary globalProperties, System.Collections.IDictionary targetOutputs)
    {
        throw new NotImplementedException();
    }

    public int ColumnNumberOfTaskNode
    {
        get { throw new NotImplementedException(); }
    }

    public bool ContinueOnError
    {
        get { throw new NotImplementedException(); }
    }

    public int LineNumberOfTaskNode
    {
        get { throw new NotImplementedException(); }
    }

    public void LogCustomEvent(CustomBuildEventArgs e)
    {
    }

    public void LogErrorEvent(BuildErrorEventArgs e)
    {
    }

    public void LogMessageEvent(BuildMessageEventArgs e)
    {
    }

    public void LogWarningEvent(BuildWarningEventArgs e)
    {
    }

    public string ProjectFileOfTaskNode
    {
        get { throw new NotImplementedException(); }
    }
}

然后是它本身的活动类：

[BuildActivity(HostEnvironmentOption.Agent)]
public sealed class WebConfigTransform : CodeActivity
{
    private const string WEB_CONFIG = "Web.config";
    private const string WEB_CONFIG_TRANSFORM_FORMAT = "Web.{0}.config";

    private IBuildEngine _buildEngine { get { return new BuildEngineStub(); } }

    [RequiredArgument]
    public InArgument<string> TransformationName { get; set; }
    [RequiredArgument]
    public InArgument<string> SourceFolder { get; set; }
    [RequiredArgument]
    public InArgument<string> DestinationFolder { get; set; }

    protected override void Execute(CodeActivityContext context)
    {
        var transformationName = context.GetValue(this.TransformationName);
        var sourceFolder = context.GetValue(this.SourceFolder);
        var destinationFolder = context.GetValue(this.DestinationFolder);

        var source = Path.Combine(sourceFolder, WEB_CONFIG);
        var destination = Path.Combine(destinationFolder, WEB_CONFIG);
        var destinationbackup = string.Format("{0}.bak", destination);
        var transform = Path.Combine(sourceFolder, string.Format(WEB_CONFIG_TRANSFORM_FORMAT, transformationName));

        if(!File.Exists(source))
            throw new ArgumentException("Web.config file doesn't exist in SourceFolder");
        if (!File.Exists(transform))
            throw new ArgumentException("Web.config transformation doesn't exist in SourceFolder");
        if (File.Exists(destination))
        {
            File.Copy(destination, destinationbackup);
            File.Delete(destination);
        }

        var transformation = new TransformXml();
        transformation.Source = new TaskItem(source);
        transformation.Destination = new TaskItem(destination);
        transformation.Transform = new TaskItem(transform);
        transformation.BuildEngine = _buildEngine;

        if (transformation.Execute())
        {
            File.Delete(destinationbackup);
        }
        else
        {
            File.Copy(destinationbackup, destination);
            File.Delete(destinationbackup);
        }
    }
}

BuildEngineStub 的原因是 TransformXml 类使用它进行日志记录。

您唯一需要注意的是 TransformXml.Execute 函数会锁定源配置文件，直到构建过程完成。