Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release/9.0] Update System.Formats.Nrbf ref sources and restore package description #108467

Merged
merged 4 commits into from
Oct 3, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Oct 2, 2024

Backport of #108430 to release/9.0

/cc @jeffhandley

Customer Impact

  • Customer reported
  • Found internally

The short package description defined in the project is shown in NuGet client tooling when showing package search results. Without the description, only the package name is shown until the package is selected and the full readme can be shown. This fix restores the short package description.

This also gets the reference assembly updated to match the implementation assembly, adding the missing private struct dummy field. Without the missing field, customers would incorrectly be able to use an uninitialized struct. The reference source is now aligned with what is produced from dotnet msbuild /t:GenerateReferenceAssemblySource to improve maintainability going forward.

Regression

  • Yes
  • No

This is a new package in .NET 9.

Testing

A local package source was added to view the updated package in the NuGet Package Manager, seeing the package description in place. The package can be added to a project and referenced as expected.

Risk

Low. Does not affect the implementation assembly at all.

This comment was marked as resolved.

1 similar comment
Copy link

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@jeffhandley jeffhandley added binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it area-System.Formats.Nrbf and removed area-Infrastructure-libraries new-api-needs-documentation labels Oct 2, 2024
Copy link
Contributor

Tagging subscribers to 'binaryformatter-migration': @adamsitnik, @bartonjs, @jeffhandley, @terrajobst

@jeffhandley jeffhandley added the Servicing-consider Issue for next servicing release review label Oct 2, 2024
@jeffhandley jeffhandley added this to the 9.0.0 milestone Oct 2, 2024
@jeffhandley jeffhandley added Servicing-approved Approved for servicing release and removed Servicing-consider Issue for next servicing release review labels Oct 3, 2024
@jeffhandley jeffhandley merged commit 0277184 into release/9.0 Oct 3, 2024
86 of 95 checks passed
@jeffhandley jeffhandley deleted the backport/pr-108430-to-release/9.0 branch October 3, 2024 06:40
@github-actions github-actions bot locked and limited conversation to collaborators Nov 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Formats.Nrbf binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it Servicing-approved Approved for servicing release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant