add changes review request message (#13647)

dotnet · May 31, 2023 · 02ad7a4 · 02ad7a4
1 parent 05ddf34
commit 02ad7a4
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/src/Microsoft.DotNet.SourceBuild/tasks/src/UsageReport/ValidateUsageAgainstBaseline.cs b/src/Microsoft.DotNet.SourceBuild/tasks/src/UsageReport/ValidateUsageAgainstBaseline.cs
@@ -4,6 +4,7 @@
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 using NuGet.Packaging.Core;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -40,9 +41,15 @@ public class ValidateUsageAgainstBaseline : Microsoft.Build.Utilities.Task
         private readonly string _preBuiltDocMessage = "See aka.ms/dotnet/prebuilts " +
             "for guidance on what pre-builts are and how to eliminate them.";
 
+        private readonly string _reviewRequestMessage = "Whenever altering this " +
+            "or other Source Build files, please make sure to include @dotnet/source-build-internal " +
+            "as a reviewer.";
+
         public override bool Execute()
         {
-            string PreBuiltDocXmlComment = $"<!-- {_preBuiltDocMessage} -->\n";
+            string ReviewRequestComment = $"<!-- {_reviewRequestMessage} -->{Environment.NewLine}";
+            string PreBuiltDocXmlComment = $"<!-- {_preBuiltDocMessage} -->{Environment.NewLine}";
+
             var used = UsageData.Parse(XElement.Parse(File.ReadAllText(DataFile)));
 
             string baselineText = string.IsNullOrEmpty(BaselineDataFile)
@@ -54,7 +61,7 @@ public override bool Execute()
             UsageValidationData data = GetUsageValidationData(baseline, used);
 
             Directory.CreateDirectory(Path.GetDirectoryName(OutputBaselineFile));
-            File.WriteAllText(OutputBaselineFile, PreBuiltDocXmlComment + data.ActualUsageData.ToXml().ToString());
+            File.WriteAllText(OutputBaselineFile, ReviewRequestComment + PreBuiltDocXmlComment + data.ActualUsageData.ToXml().ToString());
 
             Directory.CreateDirectory(Path.GetDirectoryName(OutputReportFile));
             File.WriteAllText(OutputReportFile, PreBuiltDocXmlComment + data.Report.ToString());
@@ -83,8 +90,8 @@ public UsageValidationData GetUsageValidationData(UsageData baseline, UsageData
                 tellUserToUpdateBaseline = true;
                 Log.LogError(
                     $"{diff.Added.Length} new pre-builts discovered! Detailed usage " +
-                    $"report can be found at {OutputReportFile}.\n{_preBuiltDocMessage}\n" +
-                    $"Package IDs are:\n" + string.Join("\n", diff.Added.Select(u => u.ToString())));
+                    $"report can be found at {OutputReportFile}.{Environment.NewLine}{_preBuiltDocMessage}{Environment.NewLine}" +
+                    $"Package IDs are:{Environment.NewLine}" + string.Join(Environment.NewLine, diff.Added.Select(u => u.ToString())));
 
                 // In the report, list full usage info, not only identity.
                 report.Add(