MSBuild props 文件在由 nuget 包导入时不会被评估，但在手动导入时有效答案

【问题标题】：MSBuild props file does not get evaluated when imported by a nuget package, but works when manually importedMSBuild props 文件在由 nuget 包导入时不会被评估，但在手动导入时有效
【发布时间】：2021-07-25 17:26:52
【问题描述】：

我创建了许多带有 msbuild 目标的 nuget 包，这些包可以帮助我处理 .NET 项目中的常见样板。在这里，我正在处理一个简单的.props 文件，该文件旨在使编译后的程序集和 nuget 包中的版权信息保持一致。

目前，我正在努力解决这个 props 文件在目标项目的所有构建阶段都没有得到尊重的事实。

props 文件大致如下（完整的源代码在github）：

<PropertyGroup>
  <CopyrightYearCurrent Condition=" '$(CopyrightYearCurrent)' == '' ">$([System.DateTime]::get_UtcNow().get_Year())</CopyrightYearCurrent>
  <CopyrightYear>$(CopyrightYearCurrent)</CopyrightYear>
  <!-- CopyrightYearSince may be defined externally in the consuming project and is non-mandatory -->
  <CopyrightYear Condition=" '$(Authors)' != '' AND '$(CopyrightYearSince)' != '' ">$(CopyrightYearSince)-$(CopyrightYearCurrent)</CopyrightYear>
</PropertyGroup>

<PropertyGroup>
  <Copyright Condition=" '$(Authors)' != '' AND '$(Copyright)' == '' ">Copyright © $(Authors) $(CopyrightYear)</Copyright>
</PropertyGroup>

<PropertyGroup>
  <AssemblyCompany Condition=" '$(AssemblyCompany)' == '' AND '$(Authors)' != '' ">$(Authors)</AssemblyCompany>
  <AssemblyCopyright Condition=" '$(AssemblyCopyright)' == '' AND '$(Copyright)' != '' ">$(Copyright)</AssemblyCopyright>
</PropertyGroup>

在一个目标项目中，我的根目录中有一个DirectoryBuild.props，我需要在其中激活props文件。

我的目标是，当我从命令行运行 dotnet build 或 dotnet pack 时，将来自 msbuild 的版权相关信息传播到程序集属性和 nuget 包。

最初，在 props 的开发过程中，我只是使用 MSBuild Import 指令将 props 文件导入到我的 DirectoryBuild.props 中，一切都按预期工作。

因为道具看起来很通用，我决定用它创建一个nuget package，这样我就可以在多个项目中重复使用它，并从一个中心位置对其进行维护。然后我用PackageReference 指令替换了DirectoryBuild 中props 文件的Import。

现在，当我执行 dotnet pack 时，生成的 nuget 包（以及在 obj 文件夹中自动生成的相应 nuspec 文件）不再包含 copyright 字段。同时，编译后的dll文件也正确应用了其版权信息。

我已经检查了两种方案的完整 msbuild 输出（使用命令 dotnet build -pp:msbuild.xml），并且从包中导入 props 文件的顺序与从 Directory.Build.props 手动导入的文件的导入顺序没有显着差异，因此我坚持理解观察到的行为。

这是dotnet --info 的输出，如果它对某人有任何用处：

.NET SDK（反映任何 global.json）：版本：5.0.202 提交：db7cc87d51

运行时环境：操作系统名称：Windows 操作系统版本：10.0.19042 操作系统平台：Windows 摆脱：win10-x64 基本路径：C:\Program Files\dotnet\sdk\5.0.202\

主机（用于支持）：版本：5.0.5 提交：2f740adc14

更新

只是为了消除任何怀疑，正确构建了 nuget 包（包的名称和它导入的目标相同）并且我的 IDE（JetBrains Rider）正确检测到来自 nuget 包的 .props 文件已加载。

另外，CopyrightYearSince 和 Authors 在我的 Directory.Build.props 中定义在 PackageReference 指令之前。

更新 2

似乎只有在生成自动生成的 nuspec 文件时才会出现此问题。应该参与 nuspec 的属性的 props 文件中的每个覆盖都被忽略，但是，它在其他构建任务中被适当地使用。如果直接引用 props 文件，而不是从 nuget 包中使用，问题就会消失。

【问题讨论】：

标签： msbuild nuget-package dotnet-cli

【解决方案1】：

看起来问题更复杂，因为它发生在涉及跨目标项目时。

感谢a github issue，我对GenerateNuspec 任务如何处理导入的msbuild 任务、道具和目标有了更深入的了解，因此我找到了解决自己问题的方法。详情如下：

观察到问题行为的用例是因为：

我的包含 props 和 target 的 nuget 包只包含在 build 下，而不是 buildCrossTargeting 文件夹下。
上面链接的问题告诉我，当项目是交叉定位时，GenerateNuspec 流将仅包含 buildCrossTargeting 文件夹中存在的自定义道具/目标，因此我的目标被忽略了
当我生成一个新的 nuget 包时，我同时使用了 build 和 buildCrossTargeting，问题就消失了。

结论——在创建自己的 msbuild 目标作为 nuget 包时要非常小心——跨目标项目等场景需要特殊处理！

【讨论】：