Enable Release Notes Display in NuGet Package Management (IPackageSearchMetadata)

[enf0rc3]

Result Summary: ReleaseNotes Property Integration

Technical Change Overview

The ReleaseNotes property has been added to the IPackageSearchMetadata interface and implemented throughout the NuGet package metadata pipeline, from V2 feed parsing to consumer APIs.

Package Calls That Will Now Include Release Notes

1. Core Protocol APIs

• PackageMetadataResource.GetMetadataAsync() - Returns IPackageSearchMetadata with release notes for specific package versions
• PackageSearchResourceV3.SearchAsync() - Package search results will include release notes
• V2FeedParser - Parses release notes from V2 OData feeds and populates the property

2. Visual Studio Integration

• NuGetPackageSearchService.GetPackageMetadataAsync() - VS package service calls return PackageSearchMetadataContextInfo with release notes
• NuGetPackageSearchService.GetPackageMetadataListAsync() - Package version lists include release notes
• IPackageMetadataProvider implementations - All metadata provider methods now expose release notes:
  • GetPackageMetadataAsync()
  • GetLatestPackageMetadataAsync()
  • GetPackageMetadataListAsync()
  • GetLocalPackageMetadataAsync()

3. PowerShell Cmdlets

• Get-Package -ListAvailable - Remote package listings will include release notes metadata
• Find-Package - Package search results will contain release notes
• PowerShell package enumeration - All IPackageSearchMetadata objects returned to PowerShell scripts

4. Command Line Tools

• nuget.exe search - Command-line search results have access to release notes (though not currently displayed)
• Package listing commands - Any CLI command that returns package metadata

5. Visual Studio Package Manager UI

• Package search and browsing - The PackageSearchMetadataContextInfo objects passed to UI now include release notes
• Package details - Release notes are available in the data model but NOT currently displayed in the UI (the DetailedPackageMetadata class doesn't map the release notes property)

Data Flow Path

V2FeedParser → V2FeedPackageInfo → PackageSearchMetadataV2Feed → IPackageSearchMetadata → PackageSearchMetadataContextInfo → Consumer APIs

Developer Experience Impact

✅ What Works Now

• API Consumers: Any code using IPackageSearchMetadata can access the ReleaseNotes property
• Package Source Integration: V2 feeds that provide release notes will have them parsed and available
• Local Package Metadata: Local packages will have release notes from their nuspec files via LocalPackageSearchMetadata

⚠️ Current Limitations

• Visual Studio UI: Release notes are NOT displayed in the Package Manager UI (the DetailedPackageMetadata constructor doesn't map the ReleaseNotes property from serverData.ReleaseNotes)
• Command Line Display: CLI tools have access to release notes but don't currently display them in output

🔧 Future Enhancement Opportunities

• Add release notes display to Visual Studio Package Manager UI
• Include release notes in command-line tool output formatting
• Expose release notes in package details views

Summary

The technical implementation successfully adds release notes support to the entire NuGet metadata pipeline. All core APIs and services now provide access to release notes, making them available to any consumer of IPackageSearchMetadata. However, the user-facing tools (VS UI and CLI) would need additional updates to actually display this information to end users.
This change fills a critical gap in NuGet's package discovery and information display functionality:

Additional information and impacts of this change.

NuGet packages have always supported release notes in their .nuspec files, but the Package Manager UI couldn't
display them during package browsing and search because the search metadata interface (IPackageSearchMetadata) was
missing this property.

BEFORE this change:

• ❌ Package Manager UI: Users browsing packages couldn't see release notes
• ❌ Search Results: Release notes were invisible in search/browse scenarios
• ❌ Package Discovery: Critical update information was hidden from users
• ✅ Individual Package Views: Release notes only visible when viewing specific package details (different code
  path)

AFTER this change:

• ✅ Enhanced Package Discovery: Users can now see what's new in package versions while browsing
• ✅ Informed Decision Making: Release notes help users decide whether to install/update packages
• ✅ Consistent Experience: Release notes available across all NuGet interfaces (V2 feeds, local packages, search
  results)
• ✅ Better Package Adoption: Package authors' release communications reach users during discovery

Technical Enablement:

1. Search & Browse Scenarios: Package Manager UI can now display release notes in package lists
2. Feed Compatibility: Works with both V2 legacy feeds and modern V3 feeds
3. Offline Scenarios: Local package browsing includes release notes
4. Cross-Platform: Available in Visual Studio, CLI tools, and other NuGet clients
5. Metadata Serialization: Release notes properly serialize/deserialize for remote communication

For Package Consumers:

• See breaking changes, new features, and bug fixes while browsing packages
• Make informed upgrade decisions without leaving the package list
• Understand package evolution and stability

For Package Authors:

• Release notes now reach users during the critical discovery phase
• Better communication channel for important updates and migrations
• Improved package adoption through visible change communication

This change transforms release notes from "hidden documentation" to discoverable, actionable information that enhances the entire NuGet package management experience.

Bug

Fixes:

Description

PR Checklist

• Meaningful title, helpful description and a linked NuGet/Home issue
• Added tests
• Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.

[dotnet-policy-service]

@enf0rc3 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@dotnet-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.