Update release workflow for analyzers. (#2882)

Author: timcassell

.github/workflows/release.yaml

@@ -112,6 +112,27 @@ jobs:
     - name: Publish to NuGet
       run: dotnet nuget push ./artifacts/*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
 
+    # --- Analyzer Rules ---
+
+    - name: Move analyzer rules
+      run: ./build.cmd move-analyzer-rules --version v${{ steps.version.outputs.VERSION }}
+
+    - name: Commit analyzer rules changes
+      uses: EndBug/add-and-commit@v9
+      with:
+        message: "Update released analyzer rules"
+        author_name: GitHub Actions
+        author_email: [email protected]
+        committer_name: GitHub Actions
+        committer_email: [email protected]
+
+    - name: Push git changes
+      uses: ad-m/github-push-action@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: master
+        tags: false
+
     # --- Documentation ---
 
     - name: Fetch changelog

build/BenchmarkDotNet.Build/Options/KnownOptions.cs

@@ -47,6 +47,11 @@ public static class KnownOptions
         Aliases = new[] { "-s" }
     };
 
+    public static readonly StringOption CurrentVersion = new("--current-version")
+    {
+        Description = "Specifies current version number"
+    };
+
     public static readonly StringOption NextVersion = new("--next-version")
     {
         Description = "Specifies next version number",

build/BenchmarkDotNet.Build/Program.cs

@@ -175,6 +175,27 @@ public HelpInfo GetHelp()
     }
 }
 
+[TaskName(Name)]
+[TaskDescription("Move updated analyzer rules from unshipped to shipped file")]
+public class MoveAnalyzerRulesTask : FrostingTask<BuildContext>, IHelpProvider
+{
+    private const string Name = "move-analyzer-rules";
+    public override void Run(BuildContext context) => context.DocumentationRunner.MoveAnalyzerRules();
+
+    public HelpInfo GetHelp()
+    {
+        return new HelpInfo
+        {
+            Options = [KnownOptions.CurrentVersion],
+            Examples =
+            [
+                new Example(Name)
+                    .WithArgument(KnownOptions.CurrentVersion, "v0.15.8")
+            ]
+        };
+    }
+}
+
 [TaskName(Name)]
 [TaskDescription("Pack Nupkg packages")]
 [IsDependentOn(typeof(BuildTask))]

build/BenchmarkDotNet.Build/Runners/DocumentationRunner.cs

@@ -3,6 +3,7 @@
 using System.Text;
 using BenchmarkDotNet.Build.Helpers;
 using BenchmarkDotNet.Build.Meta;
+using BenchmarkDotNet.Build.Options;
 using BenchmarkDotNet.Build.Runners.Changelog;
 using Cake.Common.Diagnostics;
 using Cake.Common.IO;
@@ -21,6 +22,9 @@ public class DocumentationRunner
     private readonly FilePath redirectFile;
     private readonly FilePath readmeFile;
     private readonly FilePath rootIndexFile;
+    private readonly FilePath analyzersShippedFile;
+    private readonly FilePath analyzersUnshippedFile;
+    private readonly FilePath analyzersPageFile;
 
     public DirectoryPath ChangelogSrcDirectory => changelogBuilder.SrcDirectory;
 
@@ -35,6 +39,33 @@ public DocumentationRunner(BuildContext context)
         docfxJsonFile = docsDirectory.CombineWithFilePath("docfx.json");
         readmeFile = context.RootDirectory.CombineWithFilePath("README.md");
         rootIndexFile = docsDirectory.CombineWithFilePath("index.md");
+
+        var analyzersDirectory = context.RootDirectory.Combine("src").Combine("BenchmarkDotNet.Analyzers");
+        analyzersShippedFile = analyzersDirectory.CombineWithFilePath("AnalyzerReleases.Shipped.md");
+        analyzersUnshippedFile = analyzersDirectory.CombineWithFilePath("AnalyzerReleases.Unshipped.md");
+        analyzersPageFile = docsGeneratedDirectory.Combine("articles").CombineWithFilePath("analyzers.md");
+    }
+
+    public void MoveAnalyzerRules()
+    {
+        if (new FileInfo(analyzersUnshippedFile.FullPath).Length == 0)
+        {
+            return;
+        }
+
+        string tempFile = System.IO.Path.GetTempFileName();
+        using (var writer = new StreamWriter(tempFile))
+        {
+            writer.WriteLine($"## {KnownOptions.CurrentVersion.Resolve(context)}");
+            CopyLines(writer, analyzersUnshippedFile);
+            writer.WriteLine();
+            writer.WriteLine();
+            CopyLines(writer, analyzersShippedFile);
+        }
+
+        File.Delete(analyzersShippedFile.FullPath);
+        File.Move(tempFile, analyzersShippedFile.FullPath);
+        File.WriteAllText(analyzersUnshippedFile.FullPath, string.Empty);
     }
 
     public void Fetch()
@@ -49,6 +80,7 @@ public void Generate()
 
         UpdateReadme();
         GenerateIndexMd();
+        GenerateAnalyzersPage();
     }
 
     public void Build()
@@ -91,6 +123,24 @@ private void GenerateIndexMd()
         context.GenerateFile(rootIndexFile, content);
     }
 
+    private void GenerateAnalyzersPage()
+    {
+        using var writer = new StreamWriter(analyzersPageFile.FullPath);
+        writer.WriteLine($"# Roslyn Analyzers for C#");
+        writer.WriteLine();
+        CopyLines(writer, analyzersShippedFile);
+    }
+
+    private static void CopyLines(StreamWriter writer, FilePath filePath)
+    {
+        using var reader = new StreamReader(filePath.FullPath);
+        while (reader.ReadLine() is { } line)
+        {
+            writer.WriteLine();
+            writer.Write(line);
+        }
+    }
+
     private void GenerateRedirects()
     {
         if (!context.FileExists(redirectFile))

docs/articles/toc.yml

@@ -16,3 +16,5 @@
   href: team.md
 - name: License
   href: license.md
+- name: Analyzers
+  href: analyzers.md