问题描述
我创建了许多带有 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
中,一切都按预期工作。
因为 props 看起来很通用,所以我决定用它创建一个 nuget package,这样我就可以在多个项目中重用它,并从一个中心位置维护它。然后我用 Import
指令替换了 DirectoryBuild
中 props 文件的 packagereference
。
现在,当我执行 dotnet pack
时,生成的 nuget 包(以及在 obj 文件夹中自动生成的相应 nuspec 文件)不再包含 copyright
字段。同时,编译后的dll文件也正确应用了版权信息。
我已经检查了两种方案的完整 msbuild 输出(使用命令 dotnet build -pp:msbuild.xml
),并且从包中导入 props 文件与从 {{1} 手动导入的文件的导入顺序没有显着差异},所以我坚持理解观察到的行为。
这是 Directory.Build.props
的输出,如果它对某人有用:
.NET SDK(反映任何 global.json): 版本:5.0.202 提交:db7cc87d51
运行时环境: 操作系统名称:Windows 操作系统版本:10.0.19042 操作系统平台:Windows RID:win10-x64 基本路径:C:\Program Files\dotnet\sdk\5.0.202\
主机(用于支持): 版本:5.0.5 提交:2f740adc14
更新
只是为了消除任何怀疑,nuget 包已正确构建(包的名称和它导入的目标是相同的)并且我的 IDE (JetBrains Rider) 正确地检测到 dotnet --info
文件来自nuget 包已加载。
此外,.props
和 copyrightYearSince
在我的 Authors
中定义在 Directory.Build.props
指令之前。
更新 2
似乎只有在生成自动生成的 nuspec 文件时才会出现问题。应该参与 nuspec 的属性的 props 文件中的每个覆盖都被忽略,但是,它在其他构建任务中被适当地使用。如果直接引用 props 文件,而不是从 nuget 包中使用,问题就会消失。
解决方法
看起来这个问题更复杂,因为它发生在涉及跨目标项目的时候。
多亏了 a github issue,我对 GenerateNuspec
任务如何处理导入的 msbuild 任务、道具和目标有了更多的了解,所以我找到了解决我自己问题的方法。详情如下:
观察到问题行为的用例是因为:
- 我的包含 props 和目标的 nuget 包只包含在
build
下,而不包含在buildCrossTargeting
文件夹下。 - 上面链接的问题告诉我,当项目是交叉目标时,
GenerateNuspec
流将只包含buildCrossTargeting
文件夹中存在的自定义道具/目标,因此我的目标被忽略立> - 当我生成一个新的 nuget 包并同时使用
build
和buildCrossTargeting
时,问题消失了。
结论 -- 在将自己的 msbuild 目标创建为 nuget 包时要非常小心 -- 跨目标项目等场景需要特殊处理!