Parse release notes as Markdown (bagetter#81)

* parse release notes as markdown * update dependency Markdig * PR feedback
Regenhardt · Feb 26, 2024 · bebc997 · bebc997
1 parent 1bbbb9e
commit bebc997
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -27,7 +27,7 @@
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="8.0.0" />
     <PackageVersion Include="coverlet.collector" Version="6.0.0" />
     <PackageVersion Include="Humanizer" Version="2.14.1" />
-    <PackageVersion Include="Markdig" Version="0.33.0" />
+    <PackageVersion Include="Markdig" Version="0.35.0" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.1" />
     <PackageVersion Include="Microsoft.Data.SqlClient" Version="[5.1.3,)" />
     <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.0" />

diff --git a/src/BaGetter.Web/Pages/Package.cshtml b/src/BaGetter.Web/Pages/Package.cshtml
@@ -117,7 +117,7 @@ else
             @if (!string.IsNullOrEmpty(Model.Package.ReleaseNotes))
             {
                 ExpandableSection("Release Notes", "ms-Icon--ReadingMode", expanded: false,
-                    @<div class="package-release-notes">@Model.Package.ReleaseNotes</div>);
+                    @<div class="package-release-notes">@Model.ParsedReleaseNotes</div>);
             }
 
             @{ ExpandableSection("Dependencies", "ms-Icon--Packages", expanded: false,

diff --git a/src/BaGetter.Web/Pages/Package.cshtml.cs b/src/BaGetter.Web/Pages/Package.cshtml.cs
@@ -56,6 +56,8 @@ public PackageModel(
 
     public HtmlString Readme { get; private set; }
 
+    public HtmlString ParsedReleaseNotes { get; private set; }
+
     public string IconUrl { get; private set; }
     public string LicenseUrl { get; private set; }
     public string PackageDownloadUrl { get; private set; }
@@ -103,6 +105,8 @@ public async Task OnGetAsync(string id, string version, CancellationToken cancel
             Readme = await GetReadmeHtmlStringOrNullAsync(Package.Id, packageVersion, cancellationToken);
         }
 
+        ParsedReleaseNotes = ParseReleaseNotes();
+
         IconUrl = Package.HasEmbeddedIcon
             ? _url.GetPackageIconDownloadUrl(Package.Id, packageVersion)
             : Package.IconUrlString;
@@ -208,6 +212,17 @@ private async Task<HtmlString> GetReadmeHtmlStringOrNullAsync(
         return new HtmlString(readmeHtml);
     }
 
+    private HtmlString ParseReleaseNotes()
+    {
+        if (string.IsNullOrWhiteSpace(Package.ReleaseNotes))
+        {
+            return HtmlString.Empty;
+        }
+
+        var releseNotesHtml = Markdown.ToHtml(Package.ReleaseNotes, MarkdownPipeline);
+        return new HtmlString(releseNotesHtml);
+    }
+
     public class DependencyGroupModel
     {
         public string Name { get; set; }