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

Show package release notes #11

Open
maraf opened this issue May 30, 2019 · 13 comments
Open

Show package release notes #11

maraf opened this issue May 30, 2019 · 13 comments
Labels
Milestone

Comments

@maraf
Copy link
Member

maraf commented May 30, 2019

Most important is it on the updates tab.

@maraf maraf added type: feature New feature or request area: package manager labels May 30, 2019
@mast-eu
Copy link
Member

mast-eu commented May 30, 2019

Good idea.
Not strictly needed for getting a minimum viable product published, but should be kept in mind for one of the first (the first?) feature release.

@mast-eu mast-eu added this to the 1.1.0 milestone May 30, 2019
@mast-eu mast-eu modified the milestones: 1.1.0, 1.2.0 Nov 15, 2019
@ghost
Copy link

ghost commented Oct 30, 2020

Where could I get the release notes?

@maraf
Copy link
Member Author

maraf commented Oct 31, 2020

Where could I get the release notes?

Release notes are part of nuget package metadata.

@maraf
Copy link
Member Author

maraf commented Oct 31, 2020

Unfortunatelly it is not part of the search results IPackageSearchMetadata.
So we whould need to execute a separate query for getting release notes for every single package.

@ghost
Copy link

ghost commented Oct 31, 2020

Thx.
Do you have a rough layout for the interface?

@maraf
Copy link
Member Author

maraf commented Oct 31, 2020

I think we can extend the IPackage.cs with a method Task<string> GetReleaseNotesAsync(CancelationToken cancelationToken).

In search UI, we can move package details into a tab and place release notes on a second tab. But I have no idea where place it on Updates tab.

@maraf
Copy link
Member Author

maraf commented Nov 5, 2020

I can confirm that, unfortunatelly. The implementation is exactly what NuGetPackage.GetContentAsync does, but I would still like to have these separated on interface level (as IPackage should be an abstraction of package for PM).

@mast-eu
Copy link
Member

mast-eu commented Nov 6, 2020

Please help me to understand: Where exactly are the "release notes" of a NuGet package? The package metadata contains a description, but I fail to see releaseNotes or anything similar.

Could you provide an example? E.g. for https://www.nuget.org/packages/newtonsoft.json/ the description is "Json.NET is a popular high-performance JSON framework for .NET", but where are it's release notes? What would the PM show if newtonsoft.json were a plugin for Git Extensions?

@ghost
Copy link

ghost commented Nov 6, 2020

https://docs.microsoft.com/en-us/nuget/reference/nuspec#releasenotes
The client API does not provide this field as part of metadate.

@ghost
Copy link

ghost commented Nov 6, 2020

image
image

Try to change version there.

@mast-eu
Copy link
Member

mast-eu commented Nov 6, 2020

Got it, thank you. You want to get release notes (if available) from the .nuspec.

Seems to have to download a package for this.

Maybe that's not necessary. Seems like you can request only the manifest file.
E.g. GET https://api.nuget.org/v3-flatcontainer/AdysTech.CredentialManager/1.7.0/AdysTech.CredentialManager.nuspec should return you this.

@maraf
Copy link
Member Author

maraf commented Nov 4, 2021

@RussKie @mast-eu I'm moving this to the release so we can publish v1.2.

@maraf maraf modified the milestones: 1.2.0, 1.3.0 Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants