Add release notes by pratikvasa · Pull Request #438 · loic-sharma/BaGet

pratikvasa · 2020-01-09T10:53:59Z

Summary of the changes (in less than 80 chars)

Added the ablity to view release notes for packages.

loic-sharma · 2020-01-21T06:45:32Z

src/BaGet.Protocol/Models/PackageMetadata.cs

+        /// The package's release notes.
+        /// </summary>
+        [JsonProperty("releaseNotes")]
+        public string ReleaseNotes { get; set; }


All the properties on PackageMetadata are part of the official NuGet protocol (see this).

Please move this to BaGetPackageMetadata, as that is where all of BaGet's custom additions to the protocol are placed. See:

BaGet/src/BaGet.Core/Metadata/BaGetPackageMetadata.cs

Line 8 in 46acdaa

/// BaGet's extensions to the package metadata model. These additions

loic-sharma · 2020-01-21T06:58:08Z

Hi, thanks for opening this pull request! Would you mind also updating the Azure Table package service? These places will need to be updated:

The PackageEntity type:

BaGet/src/BaGet.Azure/Table/PackageEntity.cs

Lines 12 to 46 in 05bfc61

    
           public class PackageEntity : TableEntity, IDownloadCount, IListed 
        
           { 
        
               public PackageEntity() 
        
               { 
        
               } 
        
               public string Id { get; set; } 
        
               public string NormalizedVersion { get; set; } 
        
               public string OriginalVersion { get; set; } 
        
               public string Authors { get; set; } 
        
               public string Description { get; set; } 
        
               public long Downloads { get; set; } 
        
               public bool HasReadme { get; set; } 
        
               public bool IsPrerelease { get; set; } 
        
               public string Language { get; set; } 
        
               public bool Listed { get; set; } 
        
               public string MinClientVersion { get; set; } 
        
               public DateTime Published { get; set; } 
        
               public bool RequireLicenseAcceptance { get; set; } 
        
               public int SemVerLevel { get; set; } 
        
               public string Summary { get; set; } 
        
               public string Title { get; set; } 
        
               public string IconUrl { get; set; } 
        
               public string LicenseUrl { get; set; } 
        
               public string ProjectUrl { get; set; } 
        
               public string RepositoryUrl { get; set; } 
        
               public string RepositoryType { get; set; } 
        
               public string Tags { get; set; } 
        
               public string Dependencies { get; set; } 
        
               public string PackageTypes { get; set; } 
        
               public string TargetFrameworks { get; set; } 
        
           }

The TableOperationBuilder.AddPackage method:

BaGet/src/BaGet.Azure/Table/TableOperationBuilder.cs

Lines 20 to 50 in 05bfc61

    
           var entity = new PackageEntity 
        
           { 
        
               PartitionKey = package.Id.ToLowerInvariant(), 
        
               RowKey = normalizedVersion.ToLowerInvariant(), 
        
               Id = package.Id, 
        
               NormalizedVersion = normalizedVersion, 
        
               OriginalVersion = version.ToFullString(), 
        
               Authors = JsonConvert.SerializeObject(package.Authors), 
        
               Description = package.Description, 
        
               Downloads = package.Downloads, 
        
               HasReadme = package.HasReadme, 
        
               IsPrerelease = package.IsPrerelease, 
        
               Language = package.Language, 
        
               Listed = package.Listed, 
        
               MinClientVersion = package.MinClientVersion, 
        
               Published = package.Published, 
        
               RequireLicenseAcceptance = package.RequireLicenseAcceptance, 
        
               SemVerLevel = (int)package.SemVerLevel, 
        
               Summary = package.Summary, 
        
               Title = package.Title, 
        
               IconUrl = package.IconUrlString, 
        
               LicenseUrl = package.LicenseUrlString, 
        
               ProjectUrl = package.ProjectUrlString, 
        
               RepositoryUrl = package.RepositoryUrlString, 
        
               RepositoryType = package.RepositoryType, 
        
               Tags = JsonConvert.SerializeObject(package.Tags), 
        
               Dependencies = SerializeList(package.Dependencies, AsDependencyModel), 
        
               PackageTypes = SerializeList(package.PackageTypes, AsPackageTypeModel), 
        
               TargetFrameworks = SerializeList(package.TargetFrameworks, f => f.Moniker) 
        
           };

The TablePackageService.AsPackage method:

BaGet/src/BaGet.Azure/Table/TablePackageService.cs

Lines 223 to 251 in 05bfc61

    
           return new Package 
        
           { 
        
               Id = entity.Id, 
        
               NormalizedVersionString = entity.NormalizedVersion, 
        
               OriginalVersionString = entity.OriginalVersion, 
        
               Authors = JsonConvert.DeserializeObject<string[]>(entity.Authors), 
        
               Description = entity.Description, 
        
               Downloads = entity.Downloads, 
        
               HasReadme = entity.HasReadme, 
        
               IsPrerelease = entity.IsPrerelease, 
        
               Language = entity.Language, 
        
               Listed = entity.Listed, 
        
               MinClientVersion = entity.MinClientVersion, 
        
               Published = entity.Published, 
        
               RequireLicenseAcceptance = entity.RequireLicenseAcceptance, 
        
               SemVerLevel = (SemVerLevel)entity.SemVerLevel, 
        
               Summary = entity.Summary, 
        
               Title = entity.Title, 
        
               IconUrl = ParseUri(entity.IconUrl), 
        
               LicenseUrl = ParseUri(entity.LicenseUrl), 
        
               ProjectUrl = ParseUri(entity.ProjectUrl), 
        
               RepositoryUrl = ParseUri(entity.RepositoryUrl), 
        
               RepositoryType = entity.RepositoryType, 
        
               Tags = JsonConvert.DeserializeObject<string[]>(entity.Tags), 
        
               Dependencies = ParseDependencies(entity.Dependencies), 
        
               PackageTypes = ParsePackageTypes(entity.PackageTypes), 
        
               TargetFrameworks = targetFrameworks, 
        
           };

Very nice work! :)

pratikvasa · 2020-01-21T08:47:59Z

Thanks for the review. Will update according to commets.

I wanted to ask you one thing. I deployed this version of Baget and replaced it with the previous release. The issue is that the Release notes did not get updated. I could see the Section in the UI, but without the actual notes.

For new packages release notes are updated properly.

What extra would I need to do so that while upgrading the release notes for old packages are also reflected.

loic-sharma · 2020-01-21T17:33:24Z

Sadly today there’s no way to “reprocess” already uploaded packages. I opened an issue to track this: #447

Today, you’ll need to:

Enable package hard deletion (see this documentation)
Download the packages you’d like to reprocess
Delete the packages using dotnet nuget delete
Reupload the packages

loic-sharma · 2020-01-21T17:38:22Z

Your changes look good to me, I’ll test this when I’m back home and then merge this in!

loic-sharma · 2020-01-22T04:43:59Z

src/BaGet.Core/Metadata/BaGetPackageMetadata.cs

+        /// The package's release notes.
+        /// </summary>
+        [JsonProperty("releaseNotes")]
+        public string ReleaseNotes { get; set; }


Could you move this to after PackageTypes but before RepositoryUrl to keep these properties alphabetically sorted?

loic-sharma · 2020-01-22T04:46:24Z

src/BaGet.UI/src/DisplayPackage/DisplayPackage.tsx

              <Dependents packageId={this.state.package.id} />
            </ExpandableSection>

+            <ExpandableSection title="Release Notes" expanded={false}>


Most packages don't have release notes. Let's hide the section if the package is missing release notes:

{this.state.package.releaseNotes && <ExpandableSection title="Release Notes" expanded={false}> <div className="package-release-notes" >{this.state.package.releaseNotes}</div> </ExpandableSection> }

loic-sharma · 2020-01-22T04:48:02Z

Ok I tested this and it worked like a charm! I left two more minor comments, I'll merge this in once you've addressed them. Thanks for all the help!

loic-sharma · 2020-01-22T06:16:23Z

Thank you @cw-pratik for the excellent pull request!

pratik vasa added 2 commits January 9, 2020 15:47

Add Release Notes to Packages

9520866

removed inline css

a34b3f0

loic-sharma reviewed Jan 21, 2020

View reviewed changes

pratik vasa added 2 commits January 21, 2020 14:20

Moved Release Notes

1a42e51

Added release notes to azure tables

3558185

loic-sharma mentioned this pull request Jan 21, 2020

Support “reflowing” packages #447

Open

loic-sharma reviewed Jan 22, 2020

View reviewed changes

Releasenotes will be shown only when available

90a77d8

loic-sharma merged commit 9d58ca5 into loic-sharma:master Jan 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add release notes#438

Add release notes#438
loic-sharma merged 5 commits intoloic-sharma:masterfrom
pratikvasa:Add-Release-Notes

pratikvasa commented Jan 9, 2020

Uh oh!

loic-sharma Jan 21, 2020

Uh oh!

loic-sharma commented Jan 21, 2020

Uh oh!

pratikvasa commented Jan 21, 2020

Uh oh!

loic-sharma commented Jan 21, 2020 •

edited

Loading

Uh oh!

loic-sharma commented Jan 21, 2020

Uh oh!

loic-sharma Jan 22, 2020

Uh oh!

loic-sharma Jan 22, 2020

Uh oh!

loic-sharma commented Jan 22, 2020

Uh oh!

loic-sharma commented Jan 22, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

pratikvasa commented Jan 9, 2020

Uh oh!

loic-sharma Jan 21, 2020

Choose a reason for hiding this comment

Uh oh!

loic-sharma commented Jan 21, 2020

Uh oh!

pratikvasa commented Jan 21, 2020

Uh oh!

loic-sharma commented Jan 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

loic-sharma commented Jan 21, 2020

Uh oh!

loic-sharma Jan 22, 2020

Choose a reason for hiding this comment

Uh oh!

loic-sharma Jan 22, 2020

Choose a reason for hiding this comment

Uh oh!

loic-sharma commented Jan 22, 2020

Uh oh!

loic-sharma commented Jan 22, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

loic-sharma commented Jan 21, 2020 •

edited

Loading