8000 Manage NuGet packages: README tab disappears after adding the README.md file to the package · Issue #14376 · NuGet/Home · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Manage NuGet packages: README tab disappears after adding the README.md file to the package #14376
Open
@vsfeedback

Description

@vsfeedback

This issue has been moved from a ticket on Developer Community.


[severity:It bothers me. A fix would be nice]

Situation

When I go to the NuGet Solution window, and select a packages in the Installed or Updated tab, I see two tabs on the right: Package Details and README. In the README tab, I read this suggestion: There is no README available for the selected package version. For more information please visit https://learn.microsoft.com/en-us/nuget/resources/nuget-faq#there-is-no-readme-in-visual-studio-nuget-package-manager-for-the-selected-package-.

For a package dependency I maintain myself, say MyPackage, I decided to add the readme.md file, so it can be viewed in the README tab.
I added this in the .csproj file:

<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
    <PackageReadmeFile>README.md</PackageReadmeFile>
  </PropertyGroup>

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

</Project>

The resulting .nuspec file is this:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
  <metadata>
    <id>MyPackage</id>
    <version>1.0.1</version>
    <readme>README.md</readme>
    <repository type="git" commit="some-commit-hash" />
    <dependencies>
      <group targetFramework="net9.0">
      </group>
    </dependencies>
  </metadata>
</package>

So, the readme node is added correctly. And at the root level of the package, the file README.md exists.

The package is published on JFrog Artifactory.

Problem

However, when I now go to the depending project in VS, and select MyPackage's update in the NuGet window. The README tab is gone. Only for this version. When I select another version, the README tab appears again. Can anybody help me identify the cause of this unexpected behavior?

I already tried:

  • Clearing the NuGet cache
  • Clean and Rebuild the project
  • Checking on other machines, same problem
  • Doing the same for another package (also on JFrog), same problem

Version Info

Microsoft Visual Studio Professional 2022
Version 17.13.0
VisualStudio.17.Release/17.13.0+35806.99
Microsoft .NET Framework
Version 4.8.04084
Installed Version: Professional

ASP.NET and Web Tools 17.13.124.35287
ASP.NET and Web Tools

C# Tools 4.13.0-3.25105.4+400efa2d94b217101a0ca61e84a3812fdc2fec52
C# components used in the IDE. Depending on your project type and settings, a different version of the compiler may be used.

NuGet Package Manager 6.13.1
NuGet Package Manager in Visual Studio. For more information about NuGet, visit https://docs.nuget.org/

OS Name: Microsoft Windows 10 Enterprise
Version: 10.0.19045 Build 19045
System Model: Virtual Machine
System Type: x64-based PC


Original Comments

Feedback Bot on 6/18/2025, 08:53 PM:

We have directed your feedback to the appropriate engineering team for further evaluation. The team will review the feedback and notify you about the next steps.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0