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

Add ReadmeUriTemplateResource for download README from remote sources. #6136

Merged
merged 14 commits into from
Nov 23, 2024

Conversation

jgonz120
Copy link
Contributor

@jgonz120 jgonz120 commented Nov 5, 2024

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.
image

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.

@jgonz120 jgonz120 requested a review from a team as a code owner November 5, 2024 20:32
Copy link
Member

@zivkan zivkan left a 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?

@microsoft-github-policy-service microsoft-github-policy-service bot added the Status:No recent activity PRs that have not had any recent activity and will be closed if the label is not removed label Nov 13, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Status:No recent activity PRs that have not had any recent activity and will be closed if the label is not removed label Nov 19, 2024
@jgonz120 jgonz120 force-pushed the dev-jgonz120-AddReadmeUriTemplateResourceType branch from 4ac41a5 to ed65992 Compare November 20, 2024 23:59
@jeffkl jeffkl self-requested a review November 21, 2024 17:11
jeffkl
jeffkl previously approved these changes Nov 21, 2024
Copy link
Contributor

@donnie-msft donnie-msft left a 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!

donnie-msft
donnie-msft previously approved these changes Nov 21, 2024
@jgonz120 jgonz120 enabled auto-merge (squash) November 23, 2024 00:18
@jgonz120 jgonz120 merged commit c0d3837 into dev Nov 23, 2024
23 checks passed
@jgonz120 jgonz120 deleted the dev-jgonz120-AddReadmeUriTemplateResourceType branch November 23, 2024 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants