Visual Studio Installer未复制发布目录全部文件的问题

我在使用Visual Studio Installer扩展创建安装包时，需要将子文件夹中的文件复制到输出根目录。安装项目采用“Publish Items from Projectname (Active)”作为输出源，本以为会打包发布目录下的所有内容，但发现通过.csproj中AfterTargets="Publish"的复制目标生成的Test.data，虽然在发布到文件夹时能出现在发布目录根目录，却不会被Installer项目的发布项包含。

最初的复制配置如下：

<Target Name="CopyTestDebug" AfterTargets="Publish" Condition="'$(Configuration)'=='Debug'">
  <ItemGroup>
    <_CopyTestDebug Include="Folder\Test_Debug.data" />
  </ItemGroup>
  <Copy SourceFiles="@(_CopyTestDebug)" DestinationFiles="$(PublishDir)Test.data" />
</Target>

<Target Name="CopyTestRelease" AfterTargets="Publish" Condition="'$(Configuration)'=='Release'">
  <ItemGroup>
    <_CopyTestRelease Include="Folder\Test_Release.data" />
  </ItemGroup>
  <Copy SourceFiles="@(_CopyTestRelease)" DestinationFiles="$(PublishDir)Test.data" />
</Target>

尝试过的临时方案及问题 #

• 曾尝试添加Content项指向发布目录的文件，但会导致Installer中文件路径带上发布文件夹的相对路径（比如bin\Release.net6.0-windows\win-x64\publish\Test.data），不符合根目录要求：

<Target Name="CopyTest2" AfterTargets="CopyTest">
  <ItemGroup>
    <Content Include="$(PublishDir)Test.data" CopyToOutputDirectory="Always"/>
  </ItemGroup>
</Target>

• 另一个临时方案是在构建前将文件复制到项目根目录并标记为Content，虽然能被Installer识别，但会污染项目目录，不是理想方案：

<Target Name="CopyTest" BeforeTargets="BeforeBuild">
  <ItemGroup>
    <_CopyTest Include="Folder\Test.data" />
  </ItemGroup>
  <Copy SourceFiles="@(_CopyTest)" DestinationFiles="Test.data" />
</Target>

<ItemGroup>
    <Content Include="Test.data" CopyToOutputDirectory="Always"/>
</ItemGroup>

正确解决方案 #

核心是让复制后的文件被VS Installer的发布项收集机制识别，需要在复制文件后，将其添加到PublishFile项中（而非普通的Content）。修改后的.csproj配置如下：

分Debug/Release版本的配置 #

<Target Name="CopyTestDebug" AfterTargets="Publish" Condition="'$(Configuration)'=='Debug'">
  <ItemGroup>
    <_CopyTestDebug Include="Folder\Test_Debug.data" />
  </ItemGroup>
  <Copy SourceFiles="@(_CopyTestDebug)" DestinationFiles="$(PublishDir)Test.data" />
  <!-- 将复制后的文件注册到PublishFile，供Installer收集 -->
  <ItemGroup>
    <PublishFile Include="$(PublishDir)Test.data">
      <Visible>False</Visible>
      <TargetPath>Test.data</TargetPath> <!-- 指定安装包中的输出路径为根目录 -->
      <PublishState>Include</PublishState>
      <IncludeHash>True</IncludeHash>
    </PublishFile>
  </ItemGroup>
</Target>

<Target Name="CopyTestRelease" AfterTargets="Publish" Condition="'$(Configuration)'=='Release'">
  <ItemGroup>
    <_CopyTestRelease Include="Folder\Test_Release.data" />
  </ItemGroup>
  <Copy SourceFiles="@(_CopyTestRelease)" DestinationFiles="$(PublishDir)Test.data" />
  <!-- 同样注册到PublishFile -->
  <ItemGroup>
    <PublishFile Include="$(PublishDir)Test.data">
      <Visible>False</Visible>
      <TargetPath>Test.data</TargetPath>
      <PublishState>Include</PublishState>
      <IncludeHash>True</IncludeHash>
    </PublishFile>
  </ItemGroup>
</Target>

简化版（自动匹配Debug/Release源文件） #

可以把两个目标合并为一个，通过MSBuild的字符串处理自动选择对应配置的源文件：

<Target Name="CopyTestData" AfterTargets="Publish">
  <!-- 根据当前配置自动选择源文件 -->
  <ItemGroup>
    <_SourceDataFile Include="Folder\Test_$([System.String]::Copy('$(Configuration)').ToLower()).data" />
  </ItemGroup>
  <Copy SourceFiles="@(_SourceDataFile)" DestinationFiles="$(PublishDir)Test.data" />
  
  <!-- 注册到PublishFile -->
  <ItemGroup>
    <PublishFile Include="$(PublishDir)Test.data">
      <Visible>False</Visible>
      <TargetPath>Test.data</TargetPath>
      <PublishState>Include</PublishState>
      <IncludeHash>True</IncludeHash>
    </PublishFile>
  </ItemGroup>
</Target>

原理说明 #

Visual Studio Installer的“Publish Items from Projectname (Active)”是基于项目的PublishFile项来收集内容的。之前的复制操作只是把文件放到了发布目录，但没有将其注册到这个集合里，所以Installer无法识别。添加PublishFile项并指定TargetPath为根目录的文件名，就能让Installer正确收集该文件，将其放到安装包的根目录下，同时不会污染项目目录。

内容的提问来源于stack exchange，提问作者Aaron Egger