-
Notifications
You must be signed in to change notification settings - Fork 695
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
Add ReadmeUriTemplateResource for download README from remote sources. #6136
Conversation
src/NuGet.Core/NuGet.Protocol/Resources/ReadmeUriTemplateResource.cs
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tech spec hasn't been approved/merged yet: https://github.com/NuGet/Home/pull/13200/files
Shouldn't we get agreement on the technical approach, before implementation?
test/NuGet.Core.Tests/NuGet.Protocol.Tests/Providers/ReadmeUriTemplateResourceProviderTests.cs
Outdated
Show resolved
Hide resolved
src/NuGet.Core/NuGet.Protocol/Resources/ReadmeUriTemplateResource.cs
Outdated
Show resolved
Hide resolved
4ac41a5
to
ed65992
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks mostly good to go, just a few minor cleanup suggestions/questions!
Bug
Fixes: https://github.com/NuGet/Client.Engineering/issues/2918
Description
Created a new resource type for generating the README download URI.
ReadmeUriTemplate/6.13.0
is the resource we will be looking for in the service index. We use the URL set in the service index as the template for generating the URI for downloading the README.Instead of directly exposing this resource type, the PackageMetadataResourceV3 class has been updated to set the ReadmeFileUrl with the URI.
Since the README will start pulling from remote sources there may be a delay while we download the README. I've added a loading message which will be displayed in the README control.
PR Checklist