Cake.Build为非SDK项目生成NuGet包时描述字段不生效问题

你使用Cake.Build打包NuGet包时，NuGetPackSettings中设置的Description被忽略，手动在.csproj中添加<Description>属性也不生效，但版本能正常设置，目标框架为.NET Framework 4.5.2。

以下是几种可行的解决方式：

1. 检查项目是否存在.nuspec文件 #

如果项目目录下有对应的.nuspec文件，NuGet打包时会优先读取该文件中的元数据（包括描述），直接覆盖csproj或Cake设置里的配置：

• 若存在.nuspec，直接修改文件中的<description>节点内容：

  <package>
    <metadata>
      <description>oops, description</description>
      <!-- 其他元数据节点 -->
    </metadata>
  </package>
  

• 若不需要使用nuspec，可在Cake的NuGetPackSettings中设置NoDefaultExcludes = true，强制忽略默认的nuspec文件（需确认Cake版本支持该属性）。

2. 通过Properties属性传递描述 #

针对传统.NET Framework csproj（非SDK格式），直接设置NuGetPackSettings.Description可能不生效，需要通过Properties字典传递元数据：

var nugetSettings = new NuGetPackSettings
{
    OutputDirectory = "%some_path%",
    Verbosity = NuGetVerbosity.Detailed,
    Version = "2.0.0",
    Properties = new Dictionary<string, string>
    {
        { "Description", "oops, description" }
    }
};

context.NuGetPack("%project_path%", nugetSettings);

3. 升级Cake的NuGet工具版本 #

旧版本的NuGet工具对传统csproj的元数据读取支持有限，可在Cake脚本中指定使用较新的NuGet版本：

// 指定新版本NuGet.exe的路径
ToolSettings.SetToolPath(NuGetTool, "./tools/NuGet.exe");

4. 显式生成并使用nuspec文件 #

如果上述方法都无效，可先通过Cake生成nuspec文件，修改描述后再打包：

// 生成包含指定描述的nuspec
context.NuGetSpec("%project_path%", new NuGetSpecSettings
{
    Properties = new Dictionary<string, string>
    {
        { "Description", "oops, description" },
        { "Version", "2.0.0" }
    }
});

// 使用生成的nuspec打包
context.NuGetPack("%project_path%.nuspec", nugetSettings);

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