Add an option to ignore all unchanged assemblies

Author: mattleibow

Mono.ApiTools.NuGetDiff/NuGetDiff.cs

@@ -64,6 +64,8 @@ static NuGetDiff()
 
 		public bool SaveAssemblyXmlDiff { get; set; } = false;
 
+		public bool SaveNuGetXmlDiff { get; set; } = true;
+
 		public string ApiInfoFileExtension { get; set; } = DefaultApiInfoFileExtension;
 
 		public string HtmlDiffFileExtension { get; set; } = DefaultHtmlDiffFileExtension;
@@ -515,10 +517,14 @@ public async Task SaveCompleteDiffToDirectoryAsync(PackageArchiveReader oldReade
 				xpackage.Add(new XAttribute("warning_total", totalWarning));
 
 			// save the package diff
-			if (!Directory.Exists(outputDirectory))
-				Directory.CreateDirectory(outputDirectory);
-			var diffPath = Path.Combine(outputDirectory, $"{(packageDiff.OldIdentity ?? packageDiff.NewIdentity).Id}.nupkg.diff.xml");
-			xPackageDiff.Save(diffPath);
+			if (SaveNuGetXmlDiff)
+			{
+				if (!Directory.Exists(outputDirectory))
+					Directory.CreateDirectory(outputDirectory);
+
+				var diffPath = Path.Combine(outputDirectory, $"{(packageDiff.OldIdentity ?? packageDiff.NewIdentity).Id}.nupkg" + GetExt(ApiInfoFileExtension, DefaultApiInfoFileExtension));
+				xPackageDiff.Save(diffPath);
+			}
 
 			IEnumerable<(string newA, string oldA)> GetAllAssemblies(NuGetFramework framework)
 			{

api-tools/NuGetDiffCommand.cs

@@ -32,6 +32,8 @@ public NuGetDiffCommand()
 
 		public bool PrePrelease { get; set; }
 
+		public bool IgnoreUnchanged { get; set; }
+
 		public string OutputDirectory { get; set; }
 
 		protected override OptionSet OnCreateOptions() => new OptionSet
@@ -42,6 +44,7 @@ public NuGetDiffCommand()
 			{ "latest", "Compare against the latest", v => Latest = true },
 			{ "output=", "The output directory", v => OutputDirectory = v },
 			{ "prerelease", "Include preprelease packages", v => PrePrelease = true },
+			{ "ignore-unchanged", "Ignore unchanged packages and assemblies", v => IgnoreUnchanged = true },
 			{ "search-path=", "A search path directory", v => SearchPaths.Add(v) },
 			{ "version=", "The version of the package to compare", v => Version = v },
 		};
@@ -187,9 +190,10 @@ private async Task DiffPackage(NuGetDiff comparer, PackageArchiveReader reader,
 				Console.WriteLine($"Running a diff on '{currentVersionNo}' vs '{olderVersion}' of '{packageId}'...");
 
 			// run the diff with all changes
-			comparer.SaveAssemblyApiInfo = true;        // we don't keep this, but it lets us know if there were no changes
-			comparer.SaveAssemblyMarkdownDiff = true;   // we want markdown
-			comparer.IgnoreResolutionErrors = true;     // we don't care if frameowrk/platform types can't be found
+			comparer.SaveNuGetXmlDiff = false;                      // this is not needed for this type of diff
+			comparer.SaveAssemblyApiInfo = !IgnoreUnchanged;        // this lets us know if there were no changes
+			comparer.SaveAssemblyMarkdownDiff = true;               // we want markdown
+			comparer.IgnoreResolutionErrors = true;                 // we don't care if frameowrk/platform types can't be found
 			comparer.MarkdownDiffFileExtension = ".diff.md";
 			comparer.IgnoreNonBreakingChanges = false;
 			await comparer.SaveCompleteDiffToDirectoryAsync(olderReader, reader, diffRoot);
@@ -199,41 +203,44 @@ private async Task DiffPackage(NuGetDiff comparer, PackageArchiveReader reader,
 			comparer.IgnoreNonBreakingChanges = true;
 			await comparer.SaveCompleteDiffToDirectoryAsync(olderReader, reader, diffRoot);
 
-			// TODO: there are two bugs in this version of mono-api-html
-			var mdFiles = Directory.EnumerateFiles(diffRoot, "*.md", SearchOption.AllDirectories);
-			foreach (var md in mdFiles)
+			if (Directory.Exists(diffRoot))
 			{
-				var contents = await File.ReadAllTextAsync(md);
+				// TODO: there are two bugs in this version of mono-api-html
+				var mdFiles = Directory.EnumerateFiles(diffRoot, "*.md", SearchOption.AllDirectories);
+				foreach (var md in mdFiles)
+				{
+					var contents = await File.ReadAllTextAsync(md);
 
-				// 1. the <h4> doesn't look pretty in the markdown
-				contents = contents.Replace("<h4>", "> ");
-				contents = contents.Replace("</h4>", Environment.NewLine);
+					// 1. the <h4> doesn't look pretty in the markdown
+					contents = contents.Replace("<h4>", "> ");
+					contents = contents.Replace("</h4>", Environment.NewLine);
 
-				// 2. newlines are inccorrect on Windows: https://github.com/mono/mono/pull/9918
-				contents = contents.Replace("\r\r", "\r");
+					// 2. newlines are inccorrect on Windows: https://github.com/mono/mono/pull/9918
+					contents = contents.Replace("\r\r", "\r");
 
-				await File.WriteAllTextAsync(md, contents);
-			}
+					await File.WriteAllTextAsync(md, contents);
+				}
 
-			// clean up the changes
-			var xmlFiles = Directory.EnumerateFiles(diffRoot, "*.xml", SearchOption.AllDirectories);
-			foreach (var file in xmlFiles)
-			{
-				// make sure to create markdown files for unchanged assemblies
-				if (file.EndsWith(".new.info.xml", StringComparison.OrdinalIgnoreCase))
+				// clean up the changes
+				var xmlFiles = Directory.EnumerateFiles(diffRoot, "*.xml", SearchOption.AllDirectories);
+				foreach (var file in xmlFiles)
 				{
-					var dll = Path.GetFileNameWithoutExtension(Path.GetFileNameWithoutExtension(Path.GetFileNameWithoutExtension(file)));
-					var md = $"{Path.GetDirectoryName(file)}/{dll}.diff.md";
-					if (!File.Exists(md))
+					// make sure to create markdown files for unchanged assemblies
+					if (file.EndsWith(".new.info.xml", StringComparison.OrdinalIgnoreCase))
 					{
-						var n = Environment.NewLine;
-						var noChangesText = $"# API diff: {dll}{n}{n}## {dll}{n}{n}> No changes.{n}";
-						await File.WriteAllTextAsync(md, noChangesText);
+						var dll = Path.GetFileNameWithoutExtension(Path.GetFileNameWithoutExtension(Path.GetFileNameWithoutExtension(file)));
+						var md = $"{Path.GetDirectoryName(file)}/{dll}.diff.md";
+						if (!File.Exists(md))
+						{
+							var n = Environment.NewLine;
+							var noChangesText = $"# API diff: {dll}{n}{n}## {dll}{n}{n}> No changes.{n}";
+							await File.WriteAllTextAsync(md, noChangesText);
+						}
 					}
-				}
 
-				// delete the info files now
-				File.Delete(file);
+					// delete the info files now
+					File.Delete(file);
+				}
 			}
 
 			// we are done