Cannot use embeded PackageReadmeFile when using snupkg for symbols

[meziantou]

Details about Problem

NuGet product used: dotnet.exe

Product version: 6.0.0-preview.3.21201.4

Worked before? If so, with which NuGet version: 🤷‍♀️

Repro steps and/or sample project

• dotnet new classlib
• Create a non-empty readme.md file
• Edit the csproj

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <RootNamespace>New_folder</RootNamespace>        
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
  </PropertyGroup>
  
  <PropertyGroup>
    <PackageReadmeFile>readme.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
    <None Include="readme.md" Pack="true" PackagePath="\" />
</ItemGroup>

</Project>

• dotnet pack

Microsoft (R) Build Engine version 16.10.0-preview-21181-07+073022eb4 for .NET
Copyright (C) Microsoft Corporation. All rights reserved.

  Determining projects to restore...
  All projects are up-to-date for restore.
  You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
  NewFolder -> C:\Users\mezia\Desktop\NewFolder\bin\Debug\net6.0\NewFolder.dll
  Successfully created package 'C:\Users\mezia\Desktop\NewFolder\bin\Debug\NewFolder.1.0.0.nupkg'.
C:\Program Files\dotnet\sdk\6.0.100-preview.3.21202.5\Sdks\NuGet.Build.Tasks.Pack\build\NuGet.Build.Tasks.Pack.targets(221,5): error NU5039: The readme file 'readme.md' does not exist in the package. [C:\Users\mezia\Desktop\NewFolder\NewFolder.csproj]

Additional information

• It can generate the package if you remove <SymbolPackageFormat>
• There is no issue with the <PackageIcon> nor <PackageLicenseFile> properties, so it seams to be only for the PackageReadmeFile

[BlackGad]

snupkg package format strongly limited with content filter by extensions (*.pdb and some more)

[zkat]

We need to look into what we do here for licenses.

[MarkStega]

Confirming the same issue with a Net5 project and "Microsoft (R) Build Engine version 16.10.0-preview-21175-01+afd0b6210 for .NET" as the build engine.

[campersau]

Maybe this is check !PackageTypes.Contains(PackageType.SymbolsPackage) which is already in ValidateLicenseFile
and ValidateIconFile needs to be added to ValidateReadmeFile too.

Also in PackageMetadataXmlExtensions the readme element is always added whereas the elements for licenseUrl and icon are not because of the same check here !PackageTypes.Contains(PackageType.SymbolsPackage).

[loic-sharma]

This blocks many popular projects from adopting embedded READMEs, including:

• Newtonsoft.Json
• Serilog
• AutoMapper
• NUnit
• NLog
• Polly
• RestSharp
• CsvHelper
• SixLabors.ImageSharp
• And lots more :(

The silver lining is that snupkg adoption is great with our most popular packages! 😅

[zkat]

@v-zubritsky can you file a separate bug for this so we can track and triage it separately?

[uladz-zubrycki]

@zkat Sure thing.

#10791

[loic-sharma]

Hello everyone, .NET 6 RC2 has been released with this fix. You can download it here: https://dotnet.microsoft.com/download/dotnet/6.0

[brminnick]

Thanks @loic-sharma! I can confirm that, using .NET 6 RC, it now works for my NuGet Packages (when it hadn't been working before .NET 6 RC2)!

I just published both with their NuGet Readme + snupkg 🎉

• AsyncAwaitBestPractices
• AsyncAwaitBestPractices.MVVM

[thargy]

Fixed for me too. 👍🏻

[RehanSaeed]

I still seem to be having issues:

• Build: https://github.com/RehanSaeed/Serilog.Enrichers.Span/pull/79/checks?check_run_id=3892346871
• PR: Add .NET 6 and C# 10 Support RehanSaeed/Serilog.Enrichers.Span#79

Successfully created package '/home/runner/work/Serilog.Enrichers.Span/Serilog.Enrichers.Span/Artefacts/Serilog.Enrichers.Span.1.4.1-preview.0.7.nupkg'.
Error: /home/runner/.dotnet/sdk/6.0.100-rc.1.21463.6/Sdks/NuGet.Build.Tasks.Pack/buildCrossTargeting/NuGet.Build.Tasks.Pack.targets(221,5): error NU5039: The readme file 'README.md' does not exist in the package. [/home/runner/work/Serilog.Enrichers.Span/Serilog.Enrichers.Span/Source/Serilog.Enrichers.Span/Serilog.Enrichers.Span.csproj]
An error occurred when executing task 'Pack'.
Error: One or more errors occurred. (.NET Core CLI: Process returned an error (exit code 1).)
	.NET Core CLI: Process returned an error (exit code 1).
Error: Process completed with exit code 1.

My directory structure:

Source
  Serilog.Enrichers.Span
    Serilog.Enrichers.Span.csproj
README.md

Any ideas where I'm going wrong?

[Apostolique]

@RehanSaeed It won't work unless you upgrade to .NET 6 RC2. That's the version with the fix. You're still on .NET 6 RC1.