[build] Rework ReadmeUpdater

Author: AndreyAkinshin

README.md

@@ -30,7 +30,11 @@ It's no harder than writing unit tests!
 Under the hood, it performs a lot of [magic](#automation) that guarantees [reliable and precise](#reliability) results thanks to the [perfolizer](https://github.com/AndreyAkinshin/perfolizer) statistical engine.
 BenchmarkDotNet protects you from popular benchmarking mistakes and warns you if something is wrong with your benchmark design or obtained measurements.
 The results are presented in a [user-friendly](#friendliness) form that highlights all the important facts about your experiment.
-The library is adopted by [16600+ GitHub projects](#who-uses-benchmarkdotnet) including .NET Runtime.
+BenchmarkDotNet is already adopted by [16600+ GitHub projects](https://github.com/dotnet/BenchmarkDotNet/network/dependents) including
+  [.NET Runtime](https://github.com/dotnet/runtime),
+  [.NET Compiler](https://github.com/dotnet/roslyn),
+  [.NET Performance](https://github.com/dotnet/performance),
+  and many others.
 
 It's [easy](#simplicity) to start writing benchmarks, check out the following example
   (copy-pastable version is [here](https://benchmarkdotnet.org/articles/guides/getting-started.html)):
@@ -229,44 +233,6 @@ Of course, you can request any additional statistics and visualizations manually
 If you don't customize the summary view,
   the default presentation will be as much user-friendly as possible. :)
 
-## Who uses BenchmarkDotNet?
-
-Everyone!
-BenchmarkDotNet is already adopted by more than [16600+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including
-  [dotnet/performance](https://github.com/dotnet/performance) (reference benchmarks for all .NET Runtimes),
-  [dotnet/runtime](https://github.com/dotnet/runtime/issues?utf8=%E2%9C%93&q=BenchmarkDotNet) (.NET runtime and libraries),
-  [Roslyn](https://github.com/dotnet/roslyn/search?q=BenchmarkDotNet&type=Issues&utf8=✓) (C# and Visual Basic compiler),
-  [Mono](https://github.com/mono/mono/tree/master/sdks/wasm/bench-runner),
-  [ASP.NET Core](https://github.com/aspnet/AspNetCore/tree/master/src/Servers/IIS/IIS/benchmarks),
-  [ML.NET](https://github.com/dotnet/machinelearning/tree/main/test/Microsoft.ML.PerformanceTests),
-  [Entity Framework Core](https://github.com/dotnet/efcore/tree/master/benchmark),
-  [PowerShell](https://github.com/PowerShell/PowerShell/tree/master/test/perf/benchmarks)
-  [SignalR](https://github.com/aspnet/SignalR/tree/master/benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks),
-  [F#](https://github.com/fsharp/fsharp/blob/master/tests/scripts/array-perf/array-perf.fs),
-  [Orleans](https://github.com/dotnet/orleans/tree/master/test/Benchmarks),
-  [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json/tree/master/Src/Newtonsoft.Json.Tests/Benchmarks),
-  [Elasticsearch.Net](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/bool-queries.html#_perfomance_considerations),
-  [Dapper](https://github.com/DapperLib/Dapper/tree/main/benchmarks/Dapper.Tests.Performance),
-  [Expecto](https://github.com/haf/expecto/tree/master/Expecto.BenchmarkDotNet),
-  [ImageSharp](https://github.com/SixLabors/ImageSharp/tree/master/tests/ImageSharp.Benchmarks),
-  [RavenDB](https://github.com/ravendb/ravendb/tree/v4.0/bench),
-  [NodaTime](https://github.com/nodatime/nodatime/tree/master/src/NodaTime.Benchmarks),
-  [Jint](https://github.com/sebastienros/jint/tree/dev/Jint.Benchmark),
-  [NServiceBus](https://github.com/Particular/NServiceBus/issues?utf8=✓&q=+BenchmarkDotNet+),
-  [Serilog](https://github.com/serilog/serilog/tree/dev/test/Serilog.PerformanceTests),
-  [Autofac](https://github.com/autofac/Autofac/tree/develop/bench/Autofac.Benchmarks),
-  [Npgsql](https://github.com/npgsql/npgsql/tree/main/test/Npgsql.Benchmarks),
-  [Avalonia](https://github.com/AvaloniaUI/Avalonia/tree/master/tests/Avalonia.Benchmarks),
-  [ReactiveUI](https://github.com/reactiveui/ReactiveUI/tree/master/src/Benchmarks),
-  [SharpZipLib](https://github.com/icsharpcode/SharpZipLib/tree/master/benchmark/ICSharpCode.SharpZipLib.Benchmark),
-  [LiteDB](https://github.com/mbdavid/LiteDB/tree/master/LiteDB.Benchmarks),
-  [GraphQL for .NET](https://github.com/graphql-dotnet/graphql-dotnet/tree/master/src/GraphQL.Benchmarks),
-  [.NET Docs](https://github.com/dotnet/docs/tree/master/samples/snippets/csharp/safe-efficient-code/benchmark),
-  [RestSharp](https://github.com/restsharp/RestSharp/tree/dev/benchmarks/RestSharp.Benchmarks),
-  [MediatR](https://github.com/jbogard/MediatR/tree/master/test/MediatR.Benchmarks),
-  [TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET/tree/master/src/TensorFlowNet.Benchmarks),
-  [Apache Thrift](https://github.com/apache/thrift/tree/master/lib/netstd/Benchmarks/Thrift.Benchmarks).  
-
 ## Learn more about benchmarking
 
 BenchmarkDotNet is not a silver bullet that magically makes all of your benchmarks correct and analyzes the measurements for you.

build/BenchmarkDotNet.Build/BuildContext.cs

@@ -34,6 +34,7 @@ public class BuildContext : FrostingContext
     public FilePathCollection AllPackableSrcProjects { get; }
     public FilePath VersionsFile { get; }
     public FilePath CommonPropsFile { get; }
+    public FilePath ReadmeFile { get; }
 
     public DotNetMSBuildSettings MsBuildSettingsRestore { get; }
     public DotNetMSBuildSettings MsBuildSettingsBuild { get; }
@@ -68,6 +69,7 @@ public BuildContext(ICakeContext context)
 
         VersionsFile = BuildDirectory.CombineWithFilePath("versions.txt");
         CommonPropsFile = BuildDirectory.CombineWithFilePath("common.props");
+        ReadmeFile = RootDirectory.CombineWithFilePath("README.md");
 
         MsBuildSettingsRestore = new DotNetMSBuildSettings();
         MsBuildSettingsBuild = new DotNetMSBuildSettings();

build/BenchmarkDotNet.Build/CommandLineParser.cs

@@ -143,11 +143,11 @@ private void PrintTaskHelp(string taskName)
             ? $"Task '{taskName}': {taskDescription}"
             : $"Task '{taskName}'");
 
-        if (string.IsNullOrWhiteSpace(helpInfo.Description))
+        if (!string.IsNullOrWhiteSpace(helpInfo.Description))
             foreach (var line in helpInfo.Description.Split('\n', StringSplitOptions.RemoveEmptyEntries))
             {
                 WritePrefix();
-                WriteLine(line.Trim());
+                WriteLine(line.TrimEnd());
             }
 
         WriteLine();

build/BenchmarkDotNet.Build/Helpers/Utils.cs

@@ -1,8 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
-using BenchmarkDotNet.Build.Options;
-using Cake.Common.Diagnostics;
+using System.Text.RegularExpressions;
 using Cake.Common.Tools.DotNet;
 using Octokit;
 
@@ -48,4 +47,15 @@ public static GitHubClient CreateGitHubClient()
         client.Credentials = tokenAuth;
         return client;
     }
+
+    public static string ApplyRegex(string content, string pattern, string newValue)
+    {
+        var regex = new Regex(pattern);
+        var match = regex.Match(content);
+        if (!match.Success)
+            throw new Exception("Failed to apply regex");
+
+        var oldValue = match.Groups[1].Value;
+        return content.Replace(oldValue, newValue);
+    }
 }

build/BenchmarkDotNet.Build/Meta/Repo.cs

@@ -1,3 +1,8 @@
+using System;
+using System.Net.Http;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+
 namespace BenchmarkDotNet.Build.Meta;
 
 public static class Repo
@@ -10,4 +15,17 @@ public static class Repo
     public const string ChangelogDetailsBranch = "docs-changelog-details";
     public const string DocsStableBranch = "docs-stable";
     public const string MasterBranch = "master";
+    
+    public static async Task<int> GetDependentProjectsNumber()
+    {
+        using var httpClient = new HttpClient();
+        const string url = $"{HttpsUrlBase}/network/dependents";
+        var response = await httpClient.GetAsync(new Uri(url));
+        var dependentsPage = await response.Content.ReadAsStringAsync();
+        var match = new Regex(@"([0-9\,]+)[\n\r\s]+Repositories").Match(dependentsPage);
+        var number = int.Parse(match.Groups[1].Value.Replace(",", ""));
+        number = number / 100 * 100;
+        return number;
+    }
+
 }

build/BenchmarkDotNet.Build/Program.cs

@@ -1,3 +1,4 @@
+using BenchmarkDotNet.Build.Meta;
 using BenchmarkDotNet.Build.Options;
 using Cake.Common;
 using Cake.Frosting;
@@ -146,6 +147,11 @@ public HelpInfo GetHelp()
     {
         return new HelpInfo
         {
+            Description = $"This task updates the following files:\n" +
+                          $"* README.md (the number of dependent projects number)\n" +
+                          $"* Last changelog footer (if {KnownOptions.Stable.CommandLineName} is specified)\n" +
+                          $"* All changelog details in docs/_changelog\n" +
+                          $"  (This dir is a cloned version of this repo from branch {Repo.ChangelogDetailsBranch})",
             Options = new IOption[] { KnownOptions.DocsPreview, KnownOptions.DocsDepth },
             EnvironmentVariables = new[] { EnvVar.GitHubToken },
             Examples = new[]

build/BenchmarkDotNet.Build/Runners/DocumentationRunner.cs

@@ -3,6 +3,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using BenchmarkDotNet.Build.Helpers;
 using BenchmarkDotNet.Build.Meta;
 using BenchmarkDotNet.Build.Options;
 using Cake.Common.Diagnostics;
@@ -59,7 +60,7 @@ public void Update()
     {
         EnvVar.GitHubToken.AssertHasValue();
 
-        ReadmeUpdater.Run(context);
+        UpdateReadme();
         UpdateLastFooter();
 
         EnsureChangelogDetailsExist();
@@ -96,6 +97,17 @@ public void Update()
                 "HEAD");
     }
 
+    private void UpdateReadme()
+    {
+        var content = Utils.ApplyRegex(
+            context.FileReadText(context.ReadmeFile),
+            @"\[(\d+)\+ GitHub projects\]",
+            Repo.GetDependentProjectsNumber().Result.ToString()
+        );
+
+        context.GenerateFile(context.ReadmeFile, content, true);
+    }
+
     public void Prepare()
     {
         foreach (var version in context.VersionHistory.StableVersions)

build/BenchmarkDotNet.Build/Runners/ReadmeUpdater.cs

@@ -67,15 +67,11 @@ private void UpdateVersionsTxt(string versionToAppend)
 
     private void UpdateCommonProps(string newCurrentVersion)
     {
-        var regex = new Regex(@"<VersionPrefix>([\d\.]+)</VersionPrefix>");
-
-        var content = context.FileReadText(context.CommonPropsFile);
-        var match = regex.Match(content);
-        if (!match.Success)
-            throw new Exception($"Failed to find VersionPrefix definition in {context.CommonPropsFile}");
-
-        var oldVersion = match.Groups[1].Value;
-        context.GenerateFile(context.CommonPropsFile, content.Replace(oldVersion, newCurrentVersion));
+        var content = Utils.ApplyRegex(
+            context.FileReadText(context.CommonPropsFile),
+            @"<VersionPrefix>([\d\.]+)</VersionPrefix>",
+            newCurrentVersion);
+        context.GenerateFile(context.CommonPropsFile, content);
     }
 
     private async Task UpdateMilestones(string nextVersion)