♻️ (config): remove deprecated TfsGitRepoMappings and TfsFieldMappings

🔧 (config): update migration config version from v15 to before16 📝 (docs): update MigrationTools.xml with new commit details ✨ (logging): add Serilog for improved logging 🔧 (config): add warning for deprecated config version The TfsGitRepoMappings and TfsFieldMappings sections are removed from the configuration as they are no longer used. The migration config version is updated from v15 to before16 to better reflect its status. Documentation is updated to reflect the latest commit details. Serilog is added to improve logging capabilities. A warning is added to notify users about the deprecated configuration version, urging them to update to v16.
nkdAgility · Aug 15, 2024 · 6777e3d · 6777e3d
1 parent 049b159
commit 6777e3d
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 23 deletions.
diff --git a/appsettings.json b/appsettings.json
@@ -79,16 +79,6 @@
           "Source Work Item Type Name": "Target Work Item Type Name"
         }
       },
-      "TfsGitRepoMappings": {
-        "Enabled": false,
-        "WorkItemGitRepos": {
-          "sourceRepoName": "targetRepoName"
-        }
-      },
-      "TfsFieldMappings": {
-        "Enabled": false,
-        "FieldMaps": []
-      },
       "TfsWorkItemEmbededLinkEnricher": {
         "Enabled": true
       },

diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml
diff --git a/src/MigrationTools.Clients.AzureDevops.ObjectModel/ServiceCollectionExtensions.cs b/src/MigrationTools.Clients.AzureDevops.ObjectModel/ServiceCollectionExtensions.cs
@@ -12,6 +12,7 @@
 using MigrationTools.ProcessorEnrichers;
 using MigrationTools.ProcessorEnrichers.WorkItemProcessorEnrichers;
 using MigrationTools.Processors;
+using Serilog;
 
 namespace MigrationTools
 {
@@ -30,8 +31,7 @@ public static void AddMigrationToolServicesForClientAzureDevOpsObjectModel(this
 
             switch (configuration.GetMigrationConfigVersion())
             {
-                case ConfigurationExtensions.MigrationConfigVersion.v15:
-
+                case ConfigurationExtensions.MigrationConfigVersion.before16:
 
                     context.AddSingleton<TfsAttachmentEnricher>().AddSingleton<IOptions<TfsAttachmentEnricherOptions>>(Microsoft.Extensions.Options.Options.Create(configuration.GetSectionCommonEnrichers_v15<TfsAttachmentEnricherOptions>(TfsAttachmentEnricherOptions.ConfigurationSectionName)));
                     context.AddSingleton<TfsUserMappingEnricher>().AddSingleton<IOptions<TfsUserMappingEnricherOptions>>(Microsoft.Extensions.Options.Options.Create(configuration.GetSectionCommonEnrichers_v15<TfsUserMappingEnricherOptions>(TfsUserMappingEnricherOptions.ConfigurationSectionName)));

diff --git a/src/MigrationTools.Host/MigrationToolHost.cs b/src/MigrationTools.Host/MigrationToolHost.cs
@@ -113,8 +113,8 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action<IConfigura
                        MigrationConfigVersion configVersion = configuration.GetMigrationConfigVersion();
                        switch (configVersion)
                        {
-                           case MigrationConfigVersion.v15:
-                               logger.LogInformation("We are moving to a new configuration format. Dont worry, we are mapping the old format to the new one, and when we move over we will provide a convertor.");
+                           case MigrationConfigVersion.before16:
+                               Log.Warning("!!ACTION REQUIRED!! You are using a deprecated version of the configuration, please update to v16. backward compatability will be removed in a future version.");
                                //logger.LogCritical("The config file {ConfigFile} uses an outdated format. We are continuing to support this format through a grace period. Use '{ExecutableName}.exe init' to create a new configuration file and port over your old configuration.", configFile, Assembly.GetEntryAssembly().GetName().Name);
                                var parsed = reader.BuildFromFile(configFile); // TODO revert tp 
                                options.FieldMaps = parsed.FieldMaps;

diff --git a/src/MigrationTools/ConfigurationSectionExtensions.cs b/src/MigrationTools/ConfigurationSectionExtensions.cs
@@ -92,7 +92,7 @@ public static partial class ConfigurationExtensions
     {
         public enum MigrationConfigVersion
         {
-            v15,
+            before16,
             v16
         }
 
@@ -135,7 +135,7 @@ public static MigrationConfigVersion GetMigrationConfigVersion(this IConfigurati
             Version.TryParse(configVersionString, out Version configVersion);
             if (configVersion < Version.Parse("16.0") || isOldFormat)
             {
-                return MigrationConfigVersion.v15;
+                return MigrationConfigVersion.before16;
             }
             else
             {

diff --git a/src/MigrationTools/ServiceCollectionExtensions.cs b/src/MigrationTools/ServiceCollectionExtensions.cs
@@ -11,6 +11,7 @@
 using MigrationTools.ProcessorEnrichers;
 using MigrationTools.ProcessorEnrichers.WorkItemProcessorEnrichers;
 using MigrationTools.Processors;
+using Serilog;
 
 namespace MigrationTools
 {
@@ -33,7 +34,8 @@ public static void AddMigrationToolServices(this IServiceCollection context, ICo
 
             switch (configuration.GetMigrationConfigVersion())
             {
-                case ConfigurationExtensions.MigrationConfigVersion.v15:
+                case ConfigurationExtensions.MigrationConfigVersion.before16:
+                    Console.WriteLine("!!ACTION REQUIRED!! You are using a deprecated version of the configuration, please update to v16. backward compatability will be removed in a future version.");
                     context.AddSingleton<StringManipulatorEnricher>().AddSingleton<IOptions<StringManipulatorEnricherOptions>>(Microsoft.Extensions.Options.Options.Create(configuration.GetSectionCommonEnrichers_v15<StringManipulatorEnricherOptions>(StringManipulatorEnricherOptions.ConfigurationSectionName)));
                     context.AddSingleton<WorkItemTypeMappingEnricher>().AddSingleton<IOptions<WorkItemTypeMappingEnricherOptions>>(Microsoft.Extensions.Options.Options.Create(configuration.GetSectionCommonEnrichers_v15<WorkItemTypeMappingEnricherOptions>(WorkItemTypeMappingEnricherOptions.ConfigurationSectionName)));
                     break;