diff --git a/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml b/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml index 544ecaed4..a23e5464d 100644 --- a/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml +++ b/docs/Reference/Generated/MigrationTools.Clients.TfsObjectModel.xml @@ -262,7 +262,7 @@ fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps; TFS should use integrated authentication. - ? + true @@ -288,13 +288,13 @@ This will create a json file with the revision history and attach it to the work item. Best used with `MaxRevisions` or `ReplayRevisions`. - ? + false If enabled, adds a comment recording the migration - false + true diff --git a/docs/Reference/Generated/MigrationTools.xml b/docs/Reference/Generated/MigrationTools.xml index 316d83c58..1f71e8ec5 100644 --- a/docs/Reference/Generated/MigrationTools.xml +++ b/docs/Reference/Generated/MigrationTools.xml @@ -258,37 +258,37 @@ - => @"topic/output-log-location" + => @"main" - => @"718c3190" + => @"cf9e4445" - => @"718c31903c2750f5170ac91a202c51682b4ebb13" + => @"cf9e4445856c9cb732b3bcc438d2d3fc23b3fa23" - => @"2024-09-19T09:18:52+01:00" + => @"2024-09-23T16:40:10+01:00" - => @"0" + => @"4" - => @"v16.0.4-Preview.3" + => @"v16.0.4-Preview.4-4-gcf9e4445" - => @"v16.0.4-Preview.3" + => @"v16.0.4-Preview.4" @@ -318,17 +318,17 @@ - => @"4" + => @"8" - => @"Preview.3" + => @"Preview.4" - => @"-Preview.3" + => @"-Preview.4" diff --git a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml index 3357ed5ae..a2ef5f2af 100644 --- a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml +++ b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml @@ -17,7 +17,8 @@ configurationSamples: "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad", "AuthenticationMode": "AccessToken", "Organisation": "https://dev.azure.com/xxx/", - "Project": "myProject" + "Project": "myProject", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -32,8 +33,7 @@ configurationSamples: "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad", "Organisation": "https://dev.azure.com/xxx/", "Project": "myProject", - "ReflectedWorkItemIdField": null, - "EndpointEnrichers": null + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions description: missing XML code comments @@ -49,10 +49,6 @@ options: type: AuthenticationMode description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Organisation type: String description: missing XML code comments diff --git a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml index 3be8c78d6..36372c2d4 100644 --- a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml +++ b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml @@ -14,8 +14,7 @@ configurationSamples: code: >- { "$type": "FileSystemWorkItemEndpointOptions", - "FileStore": null, - "EndpointEnrichers": null + "FileStore": null } sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions description: missing XML code comments @@ -23,10 +22,6 @@ className: FileSystemWorkItemEndpoint typeName: Endpoints architecture: options: -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: FileStore type: String description: missing XML code comments diff --git a/docs/_data/reference.endpoints.tfsendpoint.yaml b/docs/_data/reference.endpoints.tfsendpoint.yaml index 689427f9a..19108a0a3 100644 --- a/docs/_data/reference.endpoints.tfsendpoint.yaml +++ b/docs/_data/reference.endpoints.tfsendpoint.yaml @@ -26,7 +26,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "" + "Project": "", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -56,7 +57,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "migrationSource1" + "Project": "migrationSource1", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -78,13 +80,11 @@ configurationSamples: }, "AccessToken": "** removed as a secret ***" }, - "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId", "LanguageMaps": { "AreaPath": "Area", "IterationPath": "Iteration" - }, - "EndpointEnrichers": null + } } sampleFor: MigrationTools.Endpoints.TfsEndpointOptions description: missing XML code comments @@ -92,10 +92,6 @@ className: TfsEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -104,10 +100,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml index 0bbbfdd55..9e5d1aa6b 100644 --- a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml +++ b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml @@ -26,7 +26,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "" + "Project": "", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -52,11 +53,8 @@ configurationSamples: } }, "Collection": "https://dev.azure.com/nkdagility-preview/", - "LanguageMaps": { - "AreaPath": "Area", - "IterationPath": "Iteration" - }, - "Project": "migrationSource1" + "Project": "migrationSource1", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -78,13 +76,11 @@ configurationSamples: }, "AccessToken": "** removed as a secret ***" }, - "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId", "LanguageMaps": { "AreaPath": "Area", "IterationPath": "Iteration" - }, - "EndpointEnrichers": null + } } sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions description: missing XML code comments @@ -92,10 +88,6 @@ className: TfsTeamProjectEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -104,10 +96,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml index 3d61e1048..f99a98bfc 100644 --- a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml +++ b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml @@ -18,9 +18,10 @@ configurationSamples: "Project": null, "Authentication": null, "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, - "LanguageMaps": null, - "EndpointEnrichers": null + "LanguageMaps": { + "AreaPath": "Area", + "IterationPath": "Iteration" + } } sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions description: missing XML code comments @@ -28,10 +29,6 @@ className: TfsTeamSettingsEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -40,10 +37,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml index 6cb520117..032221da0 100644 --- a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml +++ b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml @@ -19,9 +19,10 @@ configurationSamples: "Query": null, "Authentication": null, "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, - "LanguageMaps": null, - "EndpointEnrichers": null + "LanguageMaps": { + "AreaPath": "Area", + "IterationPath": "Iteration" + } } sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions description: missing XML code comments @@ -29,10 +30,6 @@ className: TfsWorkItemEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -41,10 +38,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml b/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml index f60bff8a6..445d5ab54 100644 --- a/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml +++ b/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml @@ -63,10 +63,8 @@ configurationSamples: "BuildPipelines": null, "ReleasePipelines": null, "RepositoryNameMaps": null, - "Enrichers": null, "SourceName": "sourceName", - "TargetName": "targetName", - "RefName": null + "TargetName": "targetName" } sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions description: Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines. @@ -82,10 +80,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MigrateBuildPipelines type: Boolean description: Migrate Build Pipelines @@ -106,10 +100,6 @@ options: type: Boolean description: Migrate Valiable Groups defaultValue: true -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ReleasePipelines type: List description: List of Release Pipelines to process. If this is `null` then all Release Pipelines will be processed. diff --git a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml index 717c03949..28ee83830 100644 --- a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml +++ b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml @@ -17,14 +17,12 @@ configurationSamples: "Enabled": false, "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'", "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility", - "TargetLinksToKeepProject": "cf9756e9-69e6-4c9a-b8f4-f4f620151478", + "TargetLinksToKeepProject": "27ab4466-2eb2-45a0-abb3-6b3273112fe4", "CleanupFileName": "c:/temp/OutboundLinkTargets.bat", "PrependCommand": "start", "DryRun": true, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions description: missing XML code comments @@ -44,18 +42,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: PrependCommand type: String description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml b/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml index 20091a486..ab8ee6ecd 100644 --- a/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml +++ b/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml @@ -17,10 +17,8 @@ configurationSamples: "Enabled": false, "WIQLQuery": null, "ResultFileName": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions description: missing XML code comments @@ -32,14 +30,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ResultFileName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.processdefinitionprocessor.yaml b/docs/_data/reference.processors.processdefinitionprocessor.yaml index 0554e0550..650691d33 100644 --- a/docs/_data/reference.processors.processdefinitionprocessor.yaml +++ b/docs/_data/reference.processors.processdefinitionprocessor.yaml @@ -19,10 +19,8 @@ configurationSamples: "ProcessMaps": null, "UpdateProcessDetails": false, "MaxDegreeOfParallelism": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions description: Process definition processor used to keep processes between two orgs in sync @@ -34,10 +32,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MaxDegreeOfParallelism type: Int32 description: missing XML code comments @@ -50,10 +44,6 @@ options: type: Dictionary description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml b/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml index aa6cb56fa..3a411ce21 100644 --- a/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml +++ b/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml @@ -19,10 +19,8 @@ configurationSamples: "Username": null, "Password": null, "PictureEmpIDFormat": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions description: Downloads corporate images and updates TFS/Azure DevOps profiles @@ -38,10 +36,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: Password type: String description: The password of the user that is used to export the pictures. @@ -50,10 +44,6 @@ options: type: String description: 'TODO: You wpuld need to customise this for your system. Clone repo and run in Debug' defaultValue: String.Empty -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml b/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml index 29fd693d2..75cc554fa 100644 --- a/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml +++ b/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml @@ -17,10 +17,8 @@ configurationSamples: "Enabled": false, "WIQLQuery": null, "OnlyListUsersInWorkItems": true, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions description: ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems. Use `ExportUsersForMappingConfig` to configure. @@ -32,18 +30,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: OnlyListUsersInWorkItems type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml b/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml index d24576de3..2b0407c73 100644 --- a/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml +++ b/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml @@ -15,10 +15,8 @@ configurationSamples: { "$type": "TfsImportProfilePictureProcessorOptions", "Enabled": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions description: Downloads corporate images and updates TFS/Azure DevOps profiles @@ -30,14 +28,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfssharedqueryprocessor.yaml b/docs/_data/reference.processors.tfssharedqueryprocessor.yaml index b95665b17..fa17acff3 100644 --- a/docs/_data/reference.processors.tfssharedqueryprocessor.yaml +++ b/docs/_data/reference.processors.tfssharedqueryprocessor.yaml @@ -18,10 +18,8 @@ configurationSamples: "PrefixProjectToNodes": false, "SharedFolderName": "Shared Queries", "SourceToTargetFieldMappings": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions description: The TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another. @@ -33,18 +31,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: PrefixProjectToNodes type: Boolean description: Do we add the source project name into the folder path defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SharedFolderName type: String description: The name of the shared folder, made a parameter incase it every needs to be edited diff --git a/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml b/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml index 46df87537..ddbb18660 100644 --- a/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml +++ b/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml @@ -20,10 +20,8 @@ configurationSamples: "PrefixProjectToNodes": false, "MigrateTeamCapacities": false, "Teams": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions description: Native TFS Processor, does not work with any other Endpoints. @@ -35,10 +33,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MigrateTeamCapacities type: Boolean description: 'Migrate original team member capacities after their creation on the target team project. Note: It will only migrate team member capacity if the team member with same display name exists on the target collection otherwise it will be ignored.' @@ -51,10 +45,6 @@ options: type: Boolean description: Prefix your iterations and areas with the project name. If you have enabled this in `NodeStructuresMigrationConfig` you must do it here too. defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml b/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml index 1058db535..9a8f6d2ba 100644 --- a/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml +++ b/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml @@ -15,10 +15,8 @@ configurationSamples: { "$type": "TfsTestConfigurationsMigrationProcessorOptions", "Enabled": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions description: This processor can migrate `test configuration`. This should be run before `LinkMigrationConfig`. @@ -30,14 +28,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml b/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml index 15e84bb99..a6f9087e2 100644 --- a/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml +++ b/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml @@ -21,10 +21,8 @@ configurationSamples: "MigrationDelay": 0, "RemoveInvalidTestSuiteLinks": false, "FilterCompleted": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions description: Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration @@ -36,10 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterCompleted type: Boolean description: missing XML code comments @@ -52,10 +46,6 @@ options: type: String description: The tag name that is present on all elements that must be migrated. If this option isn't present this processor will migrate all. defaultValue: '`String.Empty`' -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: RemoveAllLinks type: Boolean description: ??Not sure what this does. Check code. diff --git a/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml b/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml index 1d37400c9..3c2fb31c6 100644 --- a/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml +++ b/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml @@ -16,10 +16,8 @@ configurationSamples: "$type": "TfsTestVariablesMigrationProcessorOptions", "Enabled": false, "Processor": "TestVariablesMigrationContext", - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions description: This processor can migrate test variables that are defined in the test plans / suites. This must run before `TestPlansAndSuitesMigrationConfig`. @@ -31,18 +29,10 @@ options: type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: Processor type: String description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml b/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml index cfcf4e2e7..23853958e 100644 --- a/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml +++ b/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml @@ -21,10 +21,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions description: This processor allows you to make changes in place where we load from teh Target and update the Target. This is used for bulk updates with the most common reason being a process template change. @@ -36,10 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -48,10 +42,6 @@ options: type: Boolean description: Pause after each work item is migrated defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml b/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml index 9838ce184..334fe6973 100644 --- a/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml +++ b/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml @@ -20,10 +20,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions description: The `WorkItemDelete` processor allows you to delete any amount of work items that meet the query. **DANGER:** This is not a recoverable action and should be use with extream caution. @@ -35,10 +33,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: missing XML code comments @@ -47,10 +41,6 @@ options: type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml b/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml index fa7a4d1f6..26ae7404b 100644 --- a/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml +++ b/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml @@ -40,22 +40,11 @@ configurationSamples: "Processors": [ { "ProcessorType": "TfsWorkItemMigrationProcessor", - "AttachRevisionHistory": "False", "Enabled": "False", "FilterWorkItemsThatAlreadyExistInTarget": "False", - "FixHtmlAttachmentLinks": "True", - "GenerateMigrationComment": "True", - "MaxGracefulFailures": "0", - "PauseAfterEachWorkItem": "False", - "SkipRevisionWithInvalidAreaPath": "False", - "SkipRevisionWithInvalidIterationPath": "False", "SourceName": "Source", "TargetName": "Target", - "UpdateCreatedBy": "True", - "UpdateCreatedDate": "True", - "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc", - "WorkItemCreateRetryLimit": "5", - "WorkItemIDs": null + "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc" } ] } @@ -73,17 +62,9 @@ configurationSamples: "FixHtmlAttachmentLinks": true, "WorkItemCreateRetryLimit": 5, "FilterWorkItemsThatAlreadyExistInTarget": false, - "PauseAfterEachWorkItem": false, - "AttachRevisionHistory": false, "GenerateMigrationComment": true, - "WorkItemIDs": null, - "MaxGracefulFailures": 0, - "SkipRevisionWithInvalidIterationPath": false, - "SkipRevisionWithInvalidAreaPath": false, - "Enrichers": null, "SourceName": "Source", - "TargetName": "Target", - "RefName": null + "TargetName": "Target" } sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions description: WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments. Use `WorkItemMigrationConfig` to configure. @@ -91,18 +72,10 @@ className: TfsWorkItemMigrationProcessor typeName: Processors architecture: options: -- parameterName: AttachRevisionHistory - type: Boolean - description: This will create a json file with the revision history and attach it to the work item. Best used with `MaxRevisions` or `ReplayRevisions`. - defaultValue: '?' - parameterName: Enabled type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -110,31 +83,11 @@ options: - parameterName: FixHtmlAttachmentLinks type: Boolean description: "**beta** If enabled this will fix any image attachments URL's, work item mention URL's or user mentions in the HTML fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps; TFS should use integrated authentication." - defaultValue: '?' + defaultValue: true - parameterName: GenerateMigrationComment type: Boolean description: If enabled, adds a comment recording the migration - defaultValue: false -- parameterName: MaxGracefulFailures - type: Int32 - description: The maximum number of failures to tolerate before the migration fails. When set above zero, a work item migration error is logged but the migration will continue until the number of failed items reaches the configured value, after which the migration fails. - defaultValue: 0 -- parameterName: PauseAfterEachWorkItem - type: Boolean - description: Pause after each work item is migrated - defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments -- parameterName: SkipRevisionWithInvalidAreaPath - type: Boolean - description: When set to true, this setting will skip a revision if the source area has not been migrated, has been deleted or is somehow invalid, etc. - defaultValue: missing XML code comments -- parameterName: SkipRevisionWithInvalidIterationPath - type: Boolean - description: This will skip a revision if the source iteration has not been migrated i.e. it was deleted - defaultValue: missing XML code comments + defaultValue: true - parameterName: SourceName type: String description: missing XML code comments @@ -159,10 +112,6 @@ options: type: Int32 description: '**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.' defaultValue: 5 -- parameterName: WorkItemIDs - type: IList - description: A list of work items to import - defaultValue: '[]' status: ready processingTarget: Work Items classFile: /src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs diff --git a/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml b/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml index b359e3cfc..3493957c0 100644 --- a/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml +++ b/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml @@ -16,10 +16,8 @@ configurationSamples: "$type": "TfsWorkItemOverwriteAreasAsTagsProcessorOptions", "Enabled": false, "AreaIterationPath": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions description: A common issue with older *TFS/Azure DevOps* instances is the proliferation of `Area Paths`. With the use of `Area Path` for `Teams` and the addition of the `Node Name` column option these extensive tag hierarchies should instad be moved to tags. @@ -35,14 +33,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml b/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml index 1cd4419cd..7f595e966 100644 --- a/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml +++ b/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml @@ -20,10 +20,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions description: Reapply field mappings after a migration. Does not migtate Work Items, only reapplied changes to filed mappings. @@ -35,10 +33,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -47,10 +41,6 @@ options: type: Boolean description: Pause after each work item is migrated defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/_data/reference.processors.workitemtrackingprocessor.yaml b/docs/_data/reference.processors.workitemtrackingprocessor.yaml index c3bb1d816..7ac13cf45 100644 --- a/docs/_data/reference.processors.workitemtrackingprocessor.yaml +++ b/docs/_data/reference.processors.workitemtrackingprocessor.yaml @@ -18,10 +18,8 @@ configurationSamples: "ReplayRevisions": false, "CollapseRevisions": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions description: This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to allow the migration of Work Items between two [Endpoints](../Endpoints/index.md). @@ -37,14 +35,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ReplayRevisions type: Boolean description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md b/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md index b99bbc26f..8a05af650 100644 --- a/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md +++ b/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md @@ -18,7 +18,8 @@ configurationSamples: "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad", "AuthenticationMode": "AccessToken", "Organisation": "https://dev.azure.com/xxx/", - "Project": "myProject" + "Project": "myProject", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -33,8 +34,7 @@ configurationSamples: "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad", "Organisation": "https://dev.azure.com/xxx/", "Project": "myProject", - "ReflectedWorkItemIdField": null, - "EndpointEnrichers": null + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions description: missing XML code comments @@ -50,10 +50,6 @@ options: type: AuthenticationMode description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Organisation type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md b/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md index 1ab655b4f..0e8927d86 100644 --- a/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md +++ b/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md @@ -15,8 +15,7 @@ configurationSamples: code: >- { "$type": "FileSystemWorkItemEndpointOptions", - "FileStore": null, - "EndpointEnrichers": null + "FileStore": null } sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions description: missing XML code comments @@ -24,10 +23,6 @@ className: FileSystemWorkItemEndpoint typeName: Endpoints architecture: options: -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: FileStore type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.tfsendpoint.md b/docs/collections/_reference/reference.endpoints.tfsendpoint.md index f77eb6590..845e7b212 100644 --- a/docs/collections/_reference/reference.endpoints.tfsendpoint.md +++ b/docs/collections/_reference/reference.endpoints.tfsendpoint.md @@ -27,7 +27,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "" + "Project": "", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -57,7 +58,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "migrationSource1" + "Project": "migrationSource1", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -79,13 +81,11 @@ configurationSamples: }, "AccessToken": "** removed as a secret ***" }, - "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId", "LanguageMaps": { "AreaPath": "Area", "IterationPath": "Iteration" - }, - "EndpointEnrichers": null + } } sampleFor: MigrationTools.Endpoints.TfsEndpointOptions description: missing XML code comments @@ -93,10 +93,6 @@ className: TfsEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -105,10 +101,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md b/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md index 61db56810..deaad76ec 100644 --- a/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md +++ b/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md @@ -27,7 +27,8 @@ configurationSamples: "AreaPath": "Area", "IterationPath": "Iteration" }, - "Project": "" + "Project": "", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -53,11 +54,8 @@ configurationSamples: } }, "Collection": "https://dev.azure.com/nkdagility-preview/", - "LanguageMaps": { - "AreaPath": "Area", - "IterationPath": "Iteration" - }, - "Project": "migrationSource1" + "Project": "migrationSource1", + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId" } } } @@ -79,13 +77,11 @@ configurationSamples: }, "AccessToken": "** removed as a secret ***" }, - "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, + "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId", "LanguageMaps": { "AreaPath": "Area", "IterationPath": "Iteration" - }, - "EndpointEnrichers": null + } } sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions description: missing XML code comments @@ -93,10 +89,6 @@ className: TfsTeamProjectEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -105,10 +97,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md b/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md index a3d76a7e8..579cae086 100644 --- a/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md +++ b/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md @@ -19,9 +19,10 @@ configurationSamples: "Project": null, "Authentication": null, "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, - "LanguageMaps": null, - "EndpointEnrichers": null + "LanguageMaps": { + "AreaPath": "Area", + "IterationPath": "Iteration" + } } sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions description: missing XML code comments @@ -29,10 +30,6 @@ className: TfsTeamSettingsEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -41,10 +38,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md b/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md index ca1b271ff..4172e06e0 100644 --- a/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md +++ b/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md @@ -20,9 +20,10 @@ configurationSamples: "Query": null, "Authentication": null, "ReflectedWorkItemIdField": null, - "AllowCrossProjectLinking": false, - "LanguageMaps": null, - "EndpointEnrichers": null + "LanguageMaps": { + "AreaPath": "Area", + "IterationPath": "Iteration" + } } sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions description: missing XML code comments @@ -30,10 +31,6 @@ className: TfsWorkItemEndpoint typeName: Endpoints architecture: options: -- parameterName: AllowCrossProjectLinking - type: Boolean - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: Authentication type: TfsAuthenticationOptions description: missing XML code comments @@ -42,10 +39,6 @@ options: type: Uri description: missing XML code comments defaultValue: missing XML code comments -- parameterName: EndpointEnrichers - type: List - description: missing XML code comments - defaultValue: missing XML code comments - parameterName: LanguageMaps type: TfsLanguageMapOptions description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md b/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md index eb5fd995b..499075ec1 100644 --- a/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md +++ b/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md @@ -64,10 +64,8 @@ configurationSamples: "BuildPipelines": null, "ReleasePipelines": null, "RepositoryNameMaps": null, - "Enrichers": null, "SourceName": "sourceName", - "TargetName": "targetName", - "RefName": null + "TargetName": "targetName" } sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions description: Azure DevOps Processor that migrates Taskgroups, Build- and Release Pipelines. @@ -83,10 +81,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MigrateBuildPipelines type: Boolean description: Migrate Build Pipelines @@ -107,10 +101,6 @@ options: type: Boolean description: Migrate Valiable Groups defaultValue: true -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ReleasePipelines type: List description: List of Release Pipelines to process. If this is `null` then all Release Pipelines will be processed. diff --git a/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md b/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md index 8ddf12384..31d6a3669 100644 --- a/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md +++ b/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md @@ -18,14 +18,12 @@ configurationSamples: "Enabled": false, "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'", "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility", - "TargetLinksToKeepProject": "cf9756e9-69e6-4c9a-b8f4-f4f620151478", + "TargetLinksToKeepProject": "27ab4466-2eb2-45a0-abb3-6b3273112fe4", "CleanupFileName": "c:/temp/OutboundLinkTargets.bat", "PrependCommand": "start", "DryRun": true, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions description: missing XML code comments @@ -45,18 +43,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: PrependCommand type: String description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md b/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md index 26f81794e..9200b93a4 100644 --- a/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md +++ b/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md @@ -18,10 +18,8 @@ configurationSamples: "Enabled": false, "WIQLQuery": null, "ResultFileName": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions description: missing XML code comments @@ -33,14 +31,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ResultFileName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.processdefinitionprocessor.md b/docs/collections/_reference/reference.processors.processdefinitionprocessor.md index 45993160e..52943a929 100644 --- a/docs/collections/_reference/reference.processors.processdefinitionprocessor.md +++ b/docs/collections/_reference/reference.processors.processdefinitionprocessor.md @@ -20,10 +20,8 @@ configurationSamples: "ProcessMaps": null, "UpdateProcessDetails": false, "MaxDegreeOfParallelism": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions description: Process definition processor used to keep processes between two orgs in sync @@ -35,10 +33,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MaxDegreeOfParallelism type: Int32 description: missing XML code comments @@ -51,10 +45,6 @@ options: type: Dictionary description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md b/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md index ca134e442..277dc8fba 100644 --- a/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md @@ -20,10 +20,8 @@ configurationSamples: "Username": null, "Password": null, "PictureEmpIDFormat": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions description: Downloads corporate images and updates TFS/Azure DevOps profiles @@ -39,10 +37,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: Password type: String description: The password of the user that is used to export the pictures. @@ -51,10 +45,6 @@ options: type: String description: 'TODO: You wpuld need to customise this for your system. Clone repo and run in Debug' defaultValue: String.Empty -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md b/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md index 16a43d665..0a792487a 100644 --- a/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md @@ -18,10 +18,8 @@ configurationSamples: "Enabled": false, "WIQLQuery": null, "OnlyListUsersInWorkItems": true, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions description: ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems. Use `ExportUsersForMappingConfig` to configure. @@ -33,18 +31,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: OnlyListUsersInWorkItems type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md b/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md index f4c65cd77..2dc91c0f3 100644 --- a/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md @@ -16,10 +16,8 @@ configurationSamples: { "$type": "TfsImportProfilePictureProcessorOptions", "Enabled": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions description: Downloads corporate images and updates TFS/Azure DevOps profiles @@ -31,14 +29,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md b/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md index f425fb88e..a093e7b29 100644 --- a/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md +++ b/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md @@ -19,10 +19,8 @@ configurationSamples: "PrefixProjectToNodes": false, "SharedFolderName": "Shared Queries", "SourceToTargetFieldMappings": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions description: The TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another. @@ -34,18 +32,10 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: PrefixProjectToNodes type: Boolean description: Do we add the source project name into the folder path defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SharedFolderName type: String description: The name of the shared folder, made a parameter incase it every needs to be edited diff --git a/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md b/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md index 196202439..70471cf29 100644 --- a/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md @@ -21,10 +21,8 @@ configurationSamples: "PrefixProjectToNodes": false, "MigrateTeamCapacities": false, "Teams": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions description: Native TFS Processor, does not work with any other Endpoints. @@ -36,10 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: MigrateTeamCapacities type: Boolean description: 'Migrate original team member capacities after their creation on the target team project. Note: It will only migrate team member capacity if the team member with same display name exists on the target collection otherwise it will be ignored.' @@ -52,10 +46,6 @@ options: type: Boolean description: Prefix your iterations and areas with the project name. If you have enabled this in `NodeStructuresMigrationConfig` you must do it here too. defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md index b8f0d9762..211916315 100644 --- a/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md +++ b/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md @@ -16,10 +16,8 @@ configurationSamples: { "$type": "TfsTestConfigurationsMigrationProcessorOptions", "Enabled": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions description: This processor can migrate `test configuration`. This should be run before `LinkMigrationConfig`. @@ -31,14 +29,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md index c7afb5c2f..31d19aef6 100644 --- a/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md +++ b/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md @@ -22,10 +22,8 @@ configurationSamples: "MigrationDelay": 0, "RemoveInvalidTestSuiteLinks": false, "FilterCompleted": false, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions description: Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration @@ -37,10 +35,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterCompleted type: Boolean description: missing XML code comments @@ -53,10 +47,6 @@ options: type: String description: The tag name that is present on all elements that must be migrated. If this option isn't present this processor will migrate all. defaultValue: '`String.Empty`' -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: RemoveAllLinks type: Boolean description: ??Not sure what this does. Check code. diff --git a/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md index b83e7ca03..ad56b60b4 100644 --- a/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md +++ b/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md @@ -17,10 +17,8 @@ configurationSamples: "$type": "TfsTestVariablesMigrationProcessorOptions", "Enabled": false, "Processor": "TestVariablesMigrationContext", - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions description: This processor can migrate test variables that are defined in the test plans / suites. This must run before `TestPlansAndSuitesMigrationConfig`. @@ -32,18 +30,10 @@ options: type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: Processor type: String description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md index 1c1fdb9e1..422c36431 100644 --- a/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md @@ -22,10 +22,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions description: This processor allows you to make changes in place where we load from teh Target and update the Target. This is used for bulk updates with the most common reason being a process template change. @@ -37,10 +35,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -49,10 +43,6 @@ options: type: Boolean description: Pause after each work item is migrated defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md index 92abaa752..c4eb23097 100644 --- a/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md @@ -21,10 +21,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions description: The `WorkItemDelete` processor allows you to delete any amount of work items that meet the query. **DANGER:** This is not a recoverable action and should be use with extream caution. @@ -36,10 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: missing XML code comments @@ -48,10 +42,6 @@ options: type: Boolean description: missing XML code comments defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md index 7b17ff47b..fad3b284a 100644 --- a/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md @@ -41,22 +41,11 @@ configurationSamples: "Processors": [ { "ProcessorType": "TfsWorkItemMigrationProcessor", - "AttachRevisionHistory": "False", "Enabled": "False", "FilterWorkItemsThatAlreadyExistInTarget": "False", - "FixHtmlAttachmentLinks": "True", - "GenerateMigrationComment": "True", - "MaxGracefulFailures": "0", - "PauseAfterEachWorkItem": "False", - "SkipRevisionWithInvalidAreaPath": "False", - "SkipRevisionWithInvalidIterationPath": "False", "SourceName": "Source", "TargetName": "Target", - "UpdateCreatedBy": "True", - "UpdateCreatedDate": "True", - "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc", - "WorkItemCreateRetryLimit": "5", - "WorkItemIDs": null + "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc" } ] } @@ -74,17 +63,9 @@ configurationSamples: "FixHtmlAttachmentLinks": true, "WorkItemCreateRetryLimit": 5, "FilterWorkItemsThatAlreadyExistInTarget": false, - "PauseAfterEachWorkItem": false, - "AttachRevisionHistory": false, "GenerateMigrationComment": true, - "WorkItemIDs": null, - "MaxGracefulFailures": 0, - "SkipRevisionWithInvalidIterationPath": false, - "SkipRevisionWithInvalidAreaPath": false, - "Enrichers": null, "SourceName": "Source", - "TargetName": "Target", - "RefName": null + "TargetName": "Target" } sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions description: WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments. Use `WorkItemMigrationConfig` to configure. @@ -92,18 +73,10 @@ className: TfsWorkItemMigrationProcessor typeName: Processors architecture: options: -- parameterName: AttachRevisionHistory - type: Boolean - description: This will create a json file with the revision history and attach it to the work item. Best used with `MaxRevisions` or `ReplayRevisions`. - defaultValue: '?' - parameterName: Enabled type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -111,31 +84,11 @@ options: - parameterName: FixHtmlAttachmentLinks type: Boolean description: "**beta** If enabled this will fix any image attachments URL's, work item mention URL's or user mentions in the HTML fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps; TFS should use integrated authentication." - defaultValue: '?' + defaultValue: true - parameterName: GenerateMigrationComment type: Boolean description: If enabled, adds a comment recording the migration - defaultValue: false -- parameterName: MaxGracefulFailures - type: Int32 - description: The maximum number of failures to tolerate before the migration fails. When set above zero, a work item migration error is logged but the migration will continue until the number of failed items reaches the configured value, after which the migration fails. - defaultValue: 0 -- parameterName: PauseAfterEachWorkItem - type: Boolean - description: Pause after each work item is migrated - defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments -- parameterName: SkipRevisionWithInvalidAreaPath - type: Boolean - description: When set to true, this setting will skip a revision if the source area has not been migrated, has been deleted or is somehow invalid, etc. - defaultValue: missing XML code comments -- parameterName: SkipRevisionWithInvalidIterationPath - type: Boolean - description: This will skip a revision if the source iteration has not been migrated i.e. it was deleted - defaultValue: missing XML code comments + defaultValue: true - parameterName: SourceName type: String description: missing XML code comments @@ -160,10 +113,6 @@ options: type: Int32 description: '**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.' defaultValue: 5 -- parameterName: WorkItemIDs - type: IList - description: A list of work items to import - defaultValue: '[]' status: ready processingTarget: Work Items classFile: /src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessor.cs diff --git a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md index 4d75e7b60..f90804522 100644 --- a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md @@ -17,10 +17,8 @@ configurationSamples: "$type": "TfsWorkItemOverwriteAreasAsTagsProcessorOptions", "Enabled": false, "AreaIterationPath": null, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions description: A common issue with older *TFS/Azure DevOps* instances is the proliferation of `Area Paths`. With the use of `Area Path` for `Teams` and the addition of the `Node Name` column option these extensive tag hierarchies should instad be moved to tags. @@ -36,14 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md index 2383e1309..d7e09fdff 100644 --- a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md +++ b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md @@ -21,10 +21,8 @@ configurationSamples: "FilterWorkItemsThatAlreadyExistInTarget": false, "PauseAfterEachWorkItem": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions description: Reapply field mappings after a migration. Does not migtate Work Items, only reapplied changes to filed mappings. @@ -36,10 +34,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments - parameterName: FilterWorkItemsThatAlreadyExistInTarget type: Boolean description: This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart. @@ -48,10 +42,6 @@ options: type: Boolean description: Pause after each work item is migrated defaultValue: false -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: SourceName type: String description: missing XML code comments diff --git a/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md b/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md index 13be8df73..f5beacbdb 100644 --- a/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md +++ b/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md @@ -19,10 +19,8 @@ configurationSamples: "ReplayRevisions": false, "CollapseRevisions": false, "WorkItemCreateRetryLimit": 0, - "Enrichers": null, "SourceName": null, - "TargetName": null, - "RefName": null + "TargetName": null } sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions description: This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to allow the migration of Work Items between two [Endpoints](../Endpoints/index.md). @@ -38,14 +36,6 @@ options: type: Boolean description: If set to `true` then the processor will run. Set to `false` and the processor will not run. defaultValue: missing XML code comments -- parameterName: Enrichers - type: List - description: List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors. - defaultValue: missing XML code comments -- parameterName: RefName - type: String - description: '`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.' - defaultValue: missing XML code comments - parameterName: ReplayRevisions type: Boolean description: missing XML code comments