Enhance validation logging and documentation for WorkItemTypeValidatorTool

Author: MrHinsh

.vscode/settings.json

@@ -3,5 +3,6 @@
     "azureFunctions.projectLanguage": "C#",
     "azureFunctions.projectRuntime": "~4",
     "debug.internalConsoleOptions": "neverOpen",
-    "azureFunctions.preDeployTask": "publish (functions)"
+    "azureFunctions.preDeployTask": "publish (functions)",
+    "dotnet.defaultSolution": "MigrationTools.slnx"
 }

docs/content/docs/reference/tools/tfs-workitemtype-validator-tool/index.md

@@ -5,6 +5,7 @@ dataFile: reference.tools.tfsworkitemtypevalidatortool.yaml
 schemaFile: schema.tools.tfsworkitemtypevalidatortool.json
 slug: work-item-type-validator-tool
 aliases:
+- /TfsWorkItemTypeValidatorTool
 - /docs/Reference/Tools/WorkItemTypeValidatorTool
 - /Reference/Tools/WorkItemTypeValidatorTool
 - /learn/azure-devops-migration-tools/Reference/Tools/WorkItemTypeValidatorTool

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs

@@ -249,6 +249,11 @@ protected override void InternalExecute()
 
         private void ValidateWorkItemTypes()
         {
+            Log.LogInformation("[ValidateWorkItemTypes]");
+            Log.LogInformation("------------------------------------");
+            Log.LogInformation("Starting Pre-Validation: Validating work item types and fields with `WorkItemTypeValidatorTool`.");
+            Log.LogInformation("Refer to https://devopsmigration.io/TfsWorkItemTypeValidatorTool/ for configuration.");
+            Log.LogInformation("------------------------------------");
             if (CommonTools.WorkItemTypeValidatorTool.Enabled)
             {
                 var sourceWits = Source.WorkItems.Project
@@ -264,6 +269,7 @@ private void ValidateWorkItemTypes()
                 if (!CommonTools.WorkItemTypeValidatorTool.ValidateWorkItemTypes(
                     sourceWits, targetWits, Target.Options.ReflectedWorkItemIdField))
                 {
+                    Log.LogError("Validation of work item types failed.");
                     Environment.Exit(-1);
                 }
             }
@@ -275,6 +281,8 @@ private void ValidateWorkItemTypes()
                     + " or migration may not work at all.";
                 Log.LogWarning(msg);
             }
+            Log.LogInformation("------------------------------------");
+            Log.LogInformation("[/ValidateWorkItemTypes]");
         }
 
         private void ValidateAllUsersExistOrAreMapped(List<WorkItemData> sourceWorkItems)

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorTool.cs

@@ -10,6 +10,10 @@
 
 namespace MigrationTools.Tools
 {
+    /// <summary>
+    /// This tool checks if the work item types in the source system have corresponding types in the target system,
+    /// and validates their fields and mappings.
+    /// </summary>
     public class TfsWorkItemTypeValidatorTool : Tool<TfsWorkItemTypeValidatorToolOptions>
     {
         private readonly IWorkItemTypeMappingTool _witMappingTool;