Add release notes (#438)

Add the ability to view packages' release notes.
loic-sharma · Jan 22, 2020 · 9d58ca5 · 9d58ca5
1 parent df8a805
commit 9d58ca5
Show file tree

Hide file tree

Showing 23 changed files with 1,006 additions and 40 deletions.
diff --git a/src/BaGet.Azure/Table/PackageEntity.cs b/src/BaGet.Azure/Table/PackageEntity.cs
@@ -29,6 +29,7 @@ public PackageEntity()
         public DateTime Published { get; set; }
         public bool RequireLicenseAcceptance { get; set; }
         public int SemVerLevel { get; set; }
+        public string ReleaseNotes { get; set; }
         public string Summary { get; set; }
         public string Title { get; set; }
 

diff --git a/src/BaGet.Azure/Table/TableOperationBuilder.cs b/src/BaGet.Azure/Table/TableOperationBuilder.cs
@@ -40,6 +40,7 @@ public TableOperation AddPackage(Package package)
                 Title = package.Title,
                 IconUrl = package.IconUrlString,
                 LicenseUrl = package.LicenseUrlString,
+                ReleaseNotes = package.ReleaseNotes,
                 ProjectUrl = package.ProjectUrlString,
                 RepositoryUrl = package.RepositoryUrlString,
                 RepositoryType = package.RepositoryType,

diff --git a/src/BaGet.Azure/Table/TablePackageService.cs b/src/BaGet.Azure/Table/TablePackageService.cs
@@ -239,6 +239,7 @@ private Package AsPackage(PackageEntity entity)
                 SemVerLevel = (SemVerLevel)entity.SemVerLevel,
                 Summary = entity.Summary,
                 Title = entity.Title,
+                ReleaseNotes = entity.ReleaseNotes,
                 IconUrl = ParseUri(entity.IconUrl),
                 LicenseUrl = ParseUri(entity.LicenseUrl),
                 ProjectUrl = ParseUri(entity.ProjectUrl),

diff --git a/src/BaGet.Core/Entities/AbstractContext.cs b/src/BaGet.Core/Entities/AbstractContext.cs
@@ -63,6 +63,10 @@ private void BuildPackageEntity(EntityTypeBuilder<Package> package)
                 .HasColumnName("OriginalVersion")
                 .HasMaxLength(MaxPackageVersionLength);
 
+            package.Property(p => p.ReleaseNotes)
+                .HasColumnName("ReleaseNotes")
+                .HasMaxLength(DefaultMaxStringLength);
+
             package.Property(p => p.Authors)
                 .HasMaxLength(DefaultMaxStringLength)
                 .HasConversion(StringArrayToJsonConverter.Instance)

diff --git a/src/BaGet.Core/Entities/Package.cs b/src/BaGet.Core/Entities/Package.cs
@@ -35,6 +35,7 @@ public NuGetVersion Version
         public long Downloads { get; set; }
         public bool HasReadme { get; set; }
         public bool IsPrerelease { get; set; }
+        public string ReleaseNotes { get; set; }
         public string Language { get; set; }
         public bool Listed { get; set; }
         public string MinClientVersion { get; set; }

diff --git a/src/BaGet.Core/Extensions/PackageArchiveReaderExtensions.cs b/src/BaGet.Core/Extensions/PackageArchiveReaderExtensions.cs
@@ -59,6 +59,7 @@ public static Package GetPackageMetadata(this PackageArchiveReader packageReader
                 HasReadme = packageReader.HasReadme(),
                 IsPrerelease = nuspec.GetVersion().IsPrerelease,
                 Language = nuspec.GetLanguage() ?? string.Empty,
+                ReleaseNotes = nuspec.GetReleaseNotes() ?? string.Empty,
                 Listed = true,
                 MinClientVersion = nuspec.GetMinClientVersion()?.ToNormalizedString() ?? string.Empty,
                 Published = DateTime.UtcNow,

diff --git a/src/BaGet.Core/Metadata/BaGetPackageMetadata.cs b/src/BaGet.Core/Metadata/BaGetPackageMetadata.cs
@@ -19,10 +19,17 @@ public class BaGetPackageMetadata : PackageMetadata
         [JsonProperty("packageTypes")]
         public IReadOnlyList<string> PackageTypes { get; set; }
 
+        /// <summary>
+        /// The package's release notes.
+        /// </summary>
+        [JsonProperty("releaseNotes")]
+        public string ReleaseNotes { get; set; }
+
         [JsonProperty("repositoryUrl")]
         public string RepositoryUrl { get; set; }
 
         [JsonProperty("repositoryType")]
         public string RepositoryType { get; set; }
+
     }
 }
diff --git a/src/BaGet.Core/Metadata/RegistrationBuilder.cs b/src/BaGet.Core/Metadata/RegistrationBuilder.cs
@@ -76,6 +76,7 @@ private RegistrationIndexPageItem ToRegistrationIndexPageItem(Package package) =
                     LicenseUrl = package.LicenseUrlString,
                     Listed = package.Listed,
                     MinClientVersion = package.MinClientVersion,
+                    ReleaseNotes = package.ReleaseNotes,
                     PackageContentUrl = _url.GetPackageDownloadUrl(package.Id, package.Version),
                     PackageTypes = package.PackageTypes.Select(t => t.Name).ToList(),
                     ProjectUrl = package.ProjectUrlString,

diff --git a/src/BaGet.Database.MySql/Migrations/20200109085155_AddReleaseNotesStringColumn.Designer.cs b/src/BaGet.Database.MySql/Migrations/20200109085155_AddReleaseNotesStringColumn.Designer.cs
diff --git a/src/BaGet.Database.MySql/Migrations/20200109085155_AddReleaseNotesStringColumn.cs b/src/BaGet.Database.MySql/Migrations/20200109085155_AddReleaseNotesStringColumn.cs
@@ -0,0 +1,40 @@
+using System;
+using Microsoft.EntityFrameworkCore.Migrations;
+
+namespace BaGet.Database.MySql.Migrations
+{
+    public partial class AddReleaseNotesStringColumn : Migration
+    {
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AlterColumn<DateTime>(
+                name: "RowVersion",
+                table: "Packages",
+                rowVersion: true,
+                nullable: true,
+                oldClrType: typeof(DateTime),
+                oldNullable: true);
+
+            migrationBuilder.AddColumn<string>(
+                name: "ReleaseNotes",
+                table: "Packages",
+                maxLength: 4000,
+                nullable: true);
+        }
+
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "ReleaseNotes",
+                table: "Packages");
+
+            migrationBuilder.AlterColumn<DateTime>(
+                name: "RowVersion",
+                table: "Packages",
+                nullable: true,
+                oldClrType: typeof(DateTime),
+                oldRowVersion: true,
+                oldNullable: true);
+        }
+    }
+}
diff --git a/src/BaGet.Database.MySql/Migrations/MySqlContextModelSnapshot.cs b/src/BaGet.Database.MySql/Migrations/MySqlContextModelSnapshot.cs
@@ -17,7 +17,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                 .HasAnnotation("ProductVersion", "2.2.6-servicing-10079")
                 .HasAnnotation("Relational:MaxIdentifierLength", 64);
 
-            modelBuilder.Entity("BaGet.Core.Entities.Package", b =>
+            modelBuilder.Entity("BaGet.Core.Package", b =>
                 {
                     b.Property<int>("Key")
                         .ValueGeneratedOnAdd();
@@ -66,6 +66,10 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.Property<DateTime>("Published");
 
+                    b.Property<string>("ReleaseNotes")
+                        .HasColumnName("ReleaseNotes")
+                        .HasMaxLength(4000);
+
                     b.Property<string>("RepositoryType")
                         .HasMaxLength(100);
 
@@ -99,7 +103,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                     b.ToTable("Packages");
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.PackageDependency", b =>
+            modelBuilder.Entity("BaGet.Core.PackageDependency", b =>
                 {
                     b.Property<int>("Key")
                         .ValueGeneratedOnAdd();
@@ -124,7 +128,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                     b.ToTable("PackageDependencies");
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.PackageType", b =>
+            modelBuilder.Entity("BaGet.Core.PackageType", b =>
                 {
                     b.Property<int>("Key")
                         .ValueGeneratedOnAdd();
@@ -146,7 +150,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                     b.ToTable("PackageTypes");
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.TargetFramework", b =>
+            modelBuilder.Entity("BaGet.Core.TargetFramework", b =>
                 {
                     b.Property<int>("Key")
                         .ValueGeneratedOnAdd();
@@ -165,24 +169,24 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                     b.ToTable("TargetFrameworks");
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.PackageDependency", b =>
+            modelBuilder.Entity("BaGet.Core.PackageDependency", b =>
                 {
-                    b.HasOne("BaGet.Core.Entities.Package", "Package")
+                    b.HasOne("BaGet.Core.Package", "Package")
                         .WithMany("Dependencies")
                         .HasForeignKey("PackageKey");
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.PackageType", b =>
+            modelBuilder.Entity("BaGet.Core.PackageType", b =>
                 {
-                    b.HasOne("BaGet.Core.Entities.Package", "Package")
+                    b.HasOne("BaGet.Core.Package", "Package")
                         .WithMany("PackageTypes")
                         .HasForeignKey("PackageKey")
                         .OnDelete(DeleteBehavior.Cascade);
                 });
 
-            modelBuilder.Entity("BaGet.Core.Entities.TargetFramework", b =>
+            modelBuilder.Entity("BaGet.Core.TargetFramework", b =>
                 {
-                    b.HasOne("BaGet.Core.Entities.Package", "Package")
+                    b.HasOne("BaGet.Core.Package", "Package")
                         .WithMany("TargetFrameworks")
                         .HasForeignKey("PackageKey")
                         .OnDelete(DeleteBehavior.Cascade);