Automatically update changelog footer

Author: AndreyAkinshin

build/BenchmarkDotNet.Build/BuildContext.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -24,6 +25,7 @@ public class BuildContext : FrostingContext
     public string BuildConfiguration { get; set; } = "Release";
     public DotNetVerbosity BuildVerbosity { get; set; } = DotNetVerbosity.Minimal;
     public int Depth { get; set; }
+    public bool VersionStable { get; }
 
     public DirectoryPath RootDirectory { get; }
     public DirectoryPath BuildDirectory { get; }
@@ -39,6 +41,8 @@ public class BuildContext : FrostingContext
 
     private bool IsCiBuild => !this.BuildSystem().IsLocalBuild;
 
+    public IReadOnlyCollection<string> NuGetPackageNames { get; }
+
     public VersionHistory VersionHistory { get; }
 
     public UnitTestRunner UnitTestRunner { get; }
@@ -73,6 +77,7 @@ public BuildContext(ICakeContext context)
         }
 
         Depth = -1;
+        VersionStable = false;
         if (context.Arguments.HasArgument("msbuild"))
         {
             var msBuildParameters = context.Arguments.GetArguments().First(it => it.Key == "msbuild").Value;
@@ -99,6 +104,9 @@ public BuildContext(ICakeContext context)
 
                     if (name.Equals("depth", StringComparison.OrdinalIgnoreCase))
                         Depth = int.Parse(value);
+
+                    if (name.Equals("VersionStable", StringComparison.OrdinalIgnoreCase) && value != "")
+                        VersionStable = true;
                 }
             }
         }
@@ -112,6 +120,15 @@ public BuildContext(ICakeContext context)
             MsBuildSettingsBuild.WithProperty("Platform", "Any CPU");
         }
 
+        var nuGetPackageNames = new List<string>();
+        nuGetPackageNames.AddRange(this
+            .GetSubDirectories(RootDirectory.Combine("src"))
+            .Select(directoryPath => directoryPath.GetDirectoryName())
+            .Where(name => !name.Contains("Disassembler", StringComparison.OrdinalIgnoreCase)));
+        nuGetPackageNames.Add("BenchmarkDotNet.Templates");
+        nuGetPackageNames.Sort();
+        NuGetPackageNames = nuGetPackageNames;
+
         VersionHistory = new VersionHistory(this, BuildDirectory.CombineWithFilePath("versions.txt"));
 
         UnitTestRunner = new UnitTestRunner(this);

build/BenchmarkDotNet.Build/Meta/VersionHistory.cs

@@ -8,13 +8,13 @@ public class VersionHistory
 {
     public string FirstCommit { get; }
     public string[] StableVersions { get; }
-    public string NextVersion { get; }
+    public string CurrentVersion { get; }
 
     public VersionHistory(BuildContext context, FilePath versionFilePath)
     {
         var lines = context.FileReadLines(versionFilePath).Where(line => !string.IsNullOrWhiteSpace(line)).ToArray();
         FirstCommit = lines.First();
-        NextVersion = lines.Last();
+        CurrentVersion = lines.Last();
         StableVersions = lines.Skip(1).SkipLast(1).ToArray();
     }
 }

build/BenchmarkDotNet.Build/Runners/DocumentationRunner.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -26,6 +27,7 @@ public class DocumentationRunner
     private readonly FilePath changelogIndexFile;
     private readonly FilePath changelogFullFile;
     private readonly FilePath changelogTocFile;
+    private readonly FilePath lastFooterFile;
 
     public DocumentationRunner(BuildContext context)
     {
@@ -34,8 +36,8 @@ public DocumentationRunner(BuildContext context)
         var docsDirectory = context.RootDirectory.Combine("docs");
         changelogDirectory = docsDirectory.Combine("changelog");
         changelogSrcDirectory = docsDirectory.Combine("_changelog");
-        docsGeneratedDirectory = docsDirectory.Combine("_site");
         changelogDetailsDirectory = changelogSrcDirectory.Combine("details");
+        docsGeneratedDirectory = docsDirectory.Combine("_site");
 
         redirectFile = docsDirectory.Combine("_redirects").CombineWithFilePath("_redirects");
         docfxJsonFile = docsDirectory.CombineWithFilePath("docfx.json");
@@ -44,13 +46,16 @@ public DocumentationRunner(BuildContext context)
         changelogIndexFile = changelogDirectory.CombineWithFilePath("index.md");
         changelogFullFile = changelogDirectory.CombineWithFilePath("full.md");
         changelogTocFile = changelogDirectory.CombineWithFilePath("toc.yml");
+        lastFooterFile = changelogSrcDirectory.Combine("footer")
+            .CombineWithFilePath("v" + context.VersionHistory.CurrentVersion + ".md");
     }
 
     public void Update()
     {
-        EnsureChangelogDetailsExist();
-
         ReadmeUpdater.Run(context);
+        UpdateLastFooter();
+
+        EnsureChangelogDetailsExist();
 
         if (string.IsNullOrEmpty(GitHubCredentials.Token))
             throw new Exception($"Environment variable '{GitHubCredentials.TokenVariableName}' is not specified!");
@@ -79,17 +84,16 @@ public void Update()
         }
 
         DocfxChangelogDownload(
-            history.NextVersion,
+            history.CurrentVersion,
             history.StableVersions.Last(),
             "HEAD");
     }
 
-
     public void Prepare()
     {
         foreach (var version in context.VersionHistory.StableVersions)
             DocfxChangelogGenerate(version);
-        DocfxChangelogGenerate(context.VersionHistory.NextVersion);
+        DocfxChangelogGenerate(context.VersionHistory.CurrentVersion);
 
         GenerateIndexMd();
         GenerateChangelogIndex();
@@ -263,4 +267,27 @@ private void GenerateRedirects()
             context.GenerateFile(fullFilePath, content);
         }
     }
+
+    private void UpdateLastFooter()
+    {
+        var version = context.VersionHistory.CurrentVersion;
+        var previousVersion = context.VersionHistory.StableVersions.Last();
+        var date = context.VersionStable
+            ? DateTime.Now.ToString("MMMM dd, yyyy", CultureInfo.InvariantCulture) 
+            : "TBA";
+
+        var content = new StringBuilder();
+        content.AppendLine($"_Date: {date}_");
+        content.AppendLine("");
+        content.AppendLine(
+            $"_Milestone: [v{version}](https://github.com/dotnet/BenchmarkDotNet/issues?q=milestone%3Av{version})_");
+        content.AppendLine(
+            $"([List of commits](https://github.com/dotnet/BenchmarkDotNet/compare/v{previousVersion}...v{version}))");
+        content.AppendLine("");
+        content.AppendLine("_NuGet Packages:_");
+        foreach (var packageName in context.NuGetPackageNames)
+            content.AppendLine($"* https://www.nuget.org/packages/{packageName}/{version}");
+
+        context.GenerateFile(lastFooterFile, content);
+    }
 }

docs/_changelog/footer/v0.13.6.md

@@ -5,7 +5,7 @@ _Milestone: [v0.13.6](https://github.com/dotnet/BenchmarkDotNet/issues?q=milesto
 
 _NuGet Packages:_
 * https://www.nuget.org/packages/BenchmarkDotNet/0.13.6
-* https://www.nuget.org/packages/BenchmarkDotNet.Diagnostics.Windows/0.13.6
-* https://www.nuget.org/packages/BenchmarkDotNet.Diagnostics.dotTrace/0.13.6
 * https://www.nuget.org/packages/BenchmarkDotNet.Annotations/0.13.6
-* https://www.nuget.org/packages/BenchmarkDotNet.Templates/0.13.6
+* https://www.nuget.org/packages/BenchmarkDotNet.Diagnostics.dotTrace/0.13.6
+* https://www.nuget.org/packages/BenchmarkDotNet.Diagnostics.Windows/0.13.6
+* https://www.nuget.org/packages/BenchmarkDotNet.Templates/0.13.6