feat: Add build information

Author: linkdotnet

Directory.Packages.props

@@ -31,6 +31,7 @@
     <PackageVersion Include="Markdig" Version="0.44.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="10.0.0" />
     <PackageVersion Include="NCronJob" Version="4.7.0" />
+		<PackageVersion Include="LinkDotNet.BuildInformation" Version="2.0.0" />
     <PackageVersion Include="ReverseMarkdown" Version="4.7.1" />
     <PackageVersion Include="System.ServiceModel.Syndication" Version="10.0.0" />
     <PackageVersion Include="NetEscapades.AspNetCore.SecurityHeaders" Version="1.3.0" />

MIGRATION.md

@@ -1,6 +1,16 @@
 # Migration Guide
 This document describes the changes that need to be made to migrate from one version of the blog to another.
 
+## 11.0 to 12.0
+`ShowBuildInformation` setting was added on the root level of the `appsettings.json` file. This setting controls whether build information (like build date) is shown in the `Footer` component.
+
+```json
+{
+  ...
+  "ShowBuildInformation": true
+}
+```
+
 ## 9.0 to 11.0
 
 A new config has been added `UseMultiAuthorMode` in `appsettings.json`. The default value of this config is `false`. If set to `true` then author name will be associated with blog posts at the time of creation.

docs/Setup/Configuration.md

@@ -48,6 +48,7 @@ The appsettings.json file has a lot of options to customize the content of the b
 	},
 	"ShowReadingIndicator": true,
 	"SimlarBlogPosts": "true",
+	"ShowBuildInformation": true,
 	"SupportMe": {
 		"KofiToken": "ABC123",
 		"GithubSponsorName": "your-tag-here",
@@ -102,6 +103,7 @@ The appsettings.json file has a lot of options to customize the content of the b
 | [Disqus](./../Comments/Disqus.md)             | node           | Enables the comment section via disqus. If left empty the comment section will not be shown.                                                                                     |
 | ShowReadingIndicator                          | boolean        | If set to `true` (default) a circle indicates the progress when a user reads a blog post (without comments).                                                                     |
 | SimilarBlogPosts                              | boolean        | If set to `true` (default) similar blog posts are shown at the end of a blog post.                                                                                               |
+| ShowBuildInformation                          | boolean        | If set to `true` (default) the build information (target framework and build timestamp) is shown in the footer.                                                                  |
 | [SupportMe](./../Donations/Readme.md)         | node           | Donation sections configuration. If left empty no donation sections will not be shown.                                                                                           |
 | [ImageStorageProvider](./../Media/Readme.md)  | string         | Declares the type of the image storage provider (currently only `Azure`).                                                                                                        |
 | [ImageStorage](./../Media/Readme.md)          | node           | Configuration for the image storage provider.                                                                                                                                    |

src/LinkDotNet.Blog.Web/ApplicationConfiguration.cs

@@ -24,5 +24,7 @@ public sealed record ApplicationConfiguration
 
     public bool ShowSimilarPosts { get; init; }
 
+    public bool ShowBuildInformation { get; init; } = true;
+
     public bool UseMultiAuthorMode { get; init; }
 }

src/LinkDotNet.Blog.Web/Features/Home/Components/Footer.razor

@@ -4,12 +4,19 @@
 @inject IOptions<ProfileInformation> ProfileInformation
 @inject IOptions<SupportMeConfiguration> SupportConfiguration
 
-<footer class="position-absolute bottom-0 w-100 text-center" style="height: 2.5rem;">
-	<span class="py-2 mb-0 text-body-secondary">© @DateTime.Now.Year @CopyrightName</span>
+<footer class="position-absolute bottom-0 w-100 text-center text-body-secondary" style="height: 2.5rem;">
+	<span>© @DateTime.Now.Year @CopyrightName</span>
+	@if (AppConfiguration.Value.ShowBuildInformation)
+	{
+		<p class="text-gray-300 mb-0">Made with ❤️, @BuildInformation.TargetFrameworkMoniker, and Blazor</p>
+		<p class="text-gray-300">
+			Built At: @(BuildInformation.BuildAt.ToString("dd-MM-yyyy HH:mm")) (UTC)
+		</p>
+	}
 	@if (SupportConfiguration.Value.ShowInFooter)
 	{
 		<div class="pb-2 d-flex justify-content-center">
-			<DonationSection />
+			<DonationSection/>
 		</div>
 	}
 </footer>

src/LinkDotNet.Blog.Web/LinkDotNet.Blog.Web.csproj

@@ -6,6 +6,7 @@
 		<PackageReference Include="Blazored.Toast"/>
 		<PackageReference Include="Blazorise.Bootstrap5"/>
 		<PackageReference Include="Blazorise.Markdown"/>
+		<PackageReference Include="LinkDotNet.BuildInformation"/>
 		<PackageReference Include="NCronJob"/>
 		<PackageReference Include="Markdig"/>
 		<PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect"/>

src/LinkDotNet.Blog.Web/appsettings.json

@@ -47,5 +47,6 @@
 	},
 	"ShowReadingIndicator": true,
 	"ShowSimilarPosts": true,
+	"ShowBuildInformation": true,
 	"UseMultiAuthorMode": false
 }

tests/LinkDotNet.Blog.TestUtilities/ApplicationConfigurationBuilder.cs

@@ -14,6 +14,7 @@ public class ApplicationConfigurationBuilder
     private bool isDisqusEnabled;
     private bool showReadingIndicator;
     private bool showSimilarPosts;
+    private bool showBuildInformation = true;
     private string? blogBrandUrl;
     private bool useMultiAuthorMode;
 
@@ -76,6 +77,12 @@ public ApplicationConfigurationBuilder WithShowSimilarPosts(bool showSimilarPost
         this.showSimilarPosts = showSimilarPosts;
         return this;
     }
+
+    public ApplicationConfigurationBuilder WithShowBuildInformation(bool showBuildInformation)
+    {
+        this.showBuildInformation = showBuildInformation;
+        return this;
+    }
 
     public ApplicationConfigurationBuilder WithBlogBrandUrl(string? blogBrandUrl)
     {
@@ -103,6 +110,7 @@ public ApplicationConfiguration Build()
             IsDisqusEnabled = isDisqusEnabled,
             ShowReadingIndicator = showReadingIndicator,
             ShowSimilarPosts = showSimilarPosts,
+            ShowBuildInformation = showBuildInformation,
             BlogBrandUrl = blogBrandUrl,
             UseMultiAuthorMode = useMultiAuthorMode,
         };

tests/LinkDotNet.Blog.UnitTests/Web/ApplicationConfigurationTests.cs

@@ -34,6 +34,7 @@ public void ShouldMapFromAppConfiguration()
             { "Giscus:CategoryId", "generalid" },
             { "Disqus:Shortname", "blog" },
             { "ShowReadingIndicator", "true" },
+            { "ShowBuildInformation", "true" },
             { "SupportMe:KofiToken", "ABC" },
             { "SupportMe:PatreonName", "linkdotnet" },
             { "SupportMe:GithubSponsorName", "linkdotnet" },
@@ -65,6 +66,7 @@ public void ShouldMapFromAppConfiguration()
         appConfiguration.BlogPostsPerPage.ShouldBe(5);
         appConfiguration.IsAboutMeEnabled.ShouldBeTrue();
         appConfiguration.ShowReadingIndicator.ShouldBeTrue();
+        appConfiguration.ShowBuildInformation.ShouldBeTrue();
         appConfiguration.UseMultiAuthorMode.ShouldBeTrue();
 
         var giscusConfiguration = new GiscusConfigurationBuilder().Build();

tests/LinkDotNet.Blog.UnitTests/Web/Features/Home/Components/FooterTests.cs

@@ -33,4 +33,31 @@ public void ShouldNotSetNameIfAboutMeIsNotEnabled()
 
         cut.Find("span").TextContent.ShouldContain("©");
     }
+
+    [Fact]
+    public void ShouldShowBuildInformationWhenEnabled()
+    {
+        var appConfig = Options.Create(new ApplicationConfigurationBuilder()
+            .WithShowBuildInformation(true)
+            .Build());
+        Services.AddScoped(_ => appConfig);
+
+        var cut = Render<Footer>();
+
+        cut.Markup.ShouldContain("Built At:");
+        cut.Markup.ShouldContain("Blazor");
+    }
+
+    [Fact]
+    public void ShouldNotShowBuildInformationWhenDisabled()
+    {
+        var appConfig = Options.Create(new ApplicationConfigurationBuilder()
+            .WithShowBuildInformation(false)
+            .Build());
+        Services.AddScoped(_ => appConfig);
+
+        var cut = Render<Footer>();
+
+        cut.Markup.ShouldNotContain("Built At:");
+    }
 }