Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add changes review request message #13647

Merged
merged 3 commits into from
May 31, 2023
Merged

add changes review request message #13647

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35057af
add changes review request message
oleksandr-didyk May 23, 2023
23a67c4
simplify naming
oleksandr-didyk May 23, 2023
0407496
use Environment.NewLine
oleksandr-didyk May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/Microsoft.DotNet.SourceBuild/tasks/src/UsageReport/ValidateUsageAgainstBaseline.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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)
Expand All @@ -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());
Expand Down Expand Up @@ -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(
Expand Down