+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+.
diff --git a/appsettings.json b/appsettings.json
index 6e17c9661..1bfc0ef6e 100644
--- a/appsettings.json
+++ b/appsettings.json
@@ -14,10 +14,10 @@
"MigrationTools": {
"EndpointDefaults": {
"TfsEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
"Collection": "",
"Project": "",
"AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
"Authentication": {
"AuthenticationMode": "AccessToken",
"AccessToken": "",
@@ -34,10 +34,10 @@
}
},
"TfsTeamProjectEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
"Collection": "",
"Project": "",
"AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
"Authentication": {
"AuthenticationMode": "AccessToken",
"AccessToken": "",
@@ -56,10 +56,10 @@
},
"EndpointSamples": {
"TfsTeamProjectEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
"Collection": "https://dev.azure.com/nkdagility-preview/",
"Project": "migrationSource1",
"AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
"Authentication": {
"AuthenticationMode": "AccessToken",
"AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
@@ -68,17 +68,13 @@
"Password": "",
"Domain": ""
}
- },
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
}
},
"TfsEndpoint": {
- "EndpointType": "TfsTeamProjectEndpoint",
"Collection": "https://dev.azure.com/nkdagility-preview/",
"Project": "migrationSource1",
"AllowCrossProjectLinking": false,
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
"Authentication": {
"AuthenticationMode": "AccessToken",
"AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
@@ -94,11 +90,11 @@
}
},
"AzureDevOpsEndpoint": {
- "EndpointType": "AzureDevOpsEndpoint",
"AuthenticationMode": "AccessToken",
"AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
"Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
+ "Project": "myProject",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
},
"CommonTools": {
@@ -154,15 +150,7 @@
"StringManipulatorTool": {
"Enabled": true,
"MaxStringLength": 1000000,
- "Manipulators": [
- {
- "$type": "RegexStringManipulator",
- "Enabled": true,
- "Pattern": "[^( -~)\n\r\t]+",
- "Replacement": "",
- "Description": "Remove invalid characters from the end of the string"
- }
- ]
+ "Manipulators": []
},
"TfsUserMappingTool": {
"Enabled": false,
@@ -451,21 +439,10 @@
},
"TfsWorkItemMigrationProcessor": {
"Enabled": false,
- "UpdateCreatedDate": true,
- "UpdateCreatedBy": 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",
- "FixHtmlAttachmentLinks": true,
- "WorkItemCreateRetryLimit": 5,
"FilterWorkItemsThatAlreadyExistInTarget": false,
- "PauseAfterEachWorkItem": false,
- "AttachRevisionHistory": false,
- "GenerateMigrationComment": true,
"SourceName": "Source",
- "TargetName": "Target",
- "WorkItemIDs": [],
- "MaxGracefulFailures": 0,
- "SkipRevisionWithInvalidIterationPath": false,
- "SkipRevisionWithInvalidAreaPath": false
+ "TargetName": "Target"
},
"ExportUsersForMappingProcessor": {
"Enabled": true,
diff --git a/configuration.json b/configuration.json
index 1189db046..89fd2514b 100644
--- a/configuration.json
+++ b/configuration.json
@@ -28,7 +28,7 @@
"Target": {
"EndpointType": "TfsTeamProjectEndpoint",
"Collection": "https://dev.azure.com/nkdagility-preview/",
- "Project": "migrationTest5",
+ "Project": "migrationTest55",
"TfsVersion": "AzureDevOps",
"Authentication": {
"AuthenticationMode": "AccessToken",
@@ -132,6 +132,18 @@
"UpdateTeamSettings": true,
"MigrateTeamCapacities": true,
"Teams": [ "Team 1", "Team 2" ]
+ },
+ "TfsUserMappingTool": {
+ "Enabled": true,
+ "UserMappingFile": "C:\\temp\\userExport.json",
+ "IdentityFieldsToCheck": [
+ "System.AssignedTo",
+ "System.ChangedBy",
+ "System.CreatedBy",
+ "Microsoft.VSTS.Common.ActivatedBy",
+ "Microsoft.VSTS.Common.ResolvedBy",
+ "Microsoft.VSTS.Common.ClosedBy"
+ ]
}
},
"Processors": [
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 e1007212a..91e793641 100644
--- a/docs/Reference/Generated/MigrationTools.xml
+++ b/docs/Reference/Generated/MigrationTools.xml
@@ -322,7 +322,6 @@
-
=> @"Preview.2"
diff --git a/docs/Reference/Processors/TestPlansAndSuitesMigrationProcessor-notes.md b/docs/Reference/Processors/TfsTestPlansAndSuitesMigrationProcessor-notes.md
similarity index 100%
rename from docs/Reference/Processors/TestPlansAndSuitesMigrationProcessor-notes.md
rename to docs/Reference/Processors/TfsTestPlansAndSuitesMigrationProcessor-notes.md
diff --git a/docs/Reference/Processors/WorkItemMigrationProcessor-introduction.md b/docs/Reference/Processors/TfsWorkItemMigrationProcessor-introduction.md
similarity index 100%
rename from docs/Reference/Processors/WorkItemMigrationProcessor-introduction.md
rename to docs/Reference/Processors/TfsWorkItemMigrationProcessor-introduction.md
diff --git a/docs/Reference/Processors/WorkItemMigrationProcessor-notes.md b/docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md
similarity index 87%
rename from docs/Reference/Processors/WorkItemMigrationProcessor-notes.md
rename to docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md
index a8709fb4a..d27b3094d 100644
--- a/docs/Reference/Processors/WorkItemMigrationProcessor-notes.md
+++ b/docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md
@@ -1,6 +1,6 @@
-## WIQL Query Bits
+## WIQL Query
-The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax).
+The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query.
> Note: A useful Azure DevOps Extension to explore WIQL is the [WIQL Editor](https://marketplace.visualstudio.com/items?itemName=ottostreifel.wiql-editor)
@@ -21,11 +21,11 @@ Scope to Area Path (Team data):
## NodeBasePath Configuration
-Moved to the ProcessorEnricher [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)
+Moved to the TfsNodeStructure
# Iteration Maps and Area Maps
-Moved to the ProcessorEnricher [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)
+Moved to the TfsNodeStructure
@@ -34,7 +34,7 @@ The above options allow you to bring over a sub-set of the WIs (using the `WIQLQ
Using the above sample structure, if you wanted to map the source project `Team 1` to target project `Team A` etc. you could add the field map as follows
-A complete list of [FieldMaps](../Reference/v1/FieldMaps/index.md) are available.
+A complete list of [FieldMaps](../Reference/FieldMaps/index.md) are available.
```
"FieldMaps": [
diff --git a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
index cc0659ad6..a15680b5f 100644
--- a/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
+++ b/docs/_data/reference.endpoints.azuredevopsendpoint.yaml
@@ -2,10 +2,12 @@ optionsClassName: AzureDevOpsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -13,19 +15,19 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "AzureDevOpsEndpoint": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "EndpointType": "AzureDevOpsEndpoint",
- "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
- }
+ "EndpointType": "AzureDevOpsEndpoint",
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "Organisation": "https://dev.azure.com/xxx/",
+ "Project": "myProject",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -34,8 +36,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
@@ -51,10 +52,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..ec2891dff 100644
--- a/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
+++ b/docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml
@@ -2,20 +2,22 @@ optionsClassName: FileSystemWorkItemEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
"$type": "FileSystemWorkItemEndpointOptions",
- "FileStore": null,
- "EndpointEnrichers": null
+ "FileStore": null
}
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
description: missing XML code comments
@@ -23,10 +25,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 58d87454f..c97e736c0 100644
--- a/docs/_data/reference.endpoints.tfsendpoint.yaml
+++ b/docs/_data/reference.endpoints.tfsendpoint.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -9,32 +10,32 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
"AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -42,31 +43,31 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "migrationSource1",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -82,13 +83,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
@@ -96,10 +95,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
@@ -108,10 +103,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 23d2571ec..63e85bac1 100644
--- a/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml
+++ b/docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsTeamProjectEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -9,32 +10,32 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
"AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -42,31 +43,27 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "Project": "migrationSource1",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -82,13 +79,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
@@ -96,10 +91,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
@@ -108,10 +99,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..c89d76353 100644
--- a/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
+++ b/docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsTeamSettingsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,9 +21,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 +32,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 +40,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..f62426294 100644
--- a/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
+++ b/docs/_data/reference.endpoints.tfsworkitemendpoint.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsWorkItemEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,9 +22,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 +33,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 +41,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.fieldmaps.fieldclearmap.yaml b/docs/_data/reference.fieldmaps.fieldclearmap.yaml
index 8e394c728..c0dff37dd 100644
--- a/docs/_data/reference.fieldmaps.fieldclearmap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldclearmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldClearMapOptions
optionsClassFullName: MigrationTools.Tools.FieldClearMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -45,6 +47,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldliteralmap.yaml b/docs/_data/reference.fieldmaps.fieldliteralmap.yaml
index e9698cec1..ff51f303d 100644
--- a/docs/_data/reference.fieldmaps.fieldliteralmap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldliteralmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldLiteralMapOptions
optionsClassFullName: MigrationTools.Tools.FieldLiteralMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -46,6 +48,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldmergemap.yaml b/docs/_data/reference.fieldmaps.fieldmergemap.yaml
index 3ac96ea1d..667d8acca 100644
--- a/docs/_data/reference.fieldmaps.fieldmergemap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldmergemap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldMergeMapOptions
optionsClassFullName: MigrationTools.Tools.FieldMergeMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldskipmap.yaml b/docs/_data/reference.fieldmaps.fieldskipmap.yaml
index 96d86aa6a..8230b2e7e 100644
--- a/docs/_data/reference.fieldmaps.fieldskipmap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldskipmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldSkipMapOptions
optionsClassFullName: MigrationTools.Tools.FieldSkipMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,10 +24,12 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml b/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml
index 903aa8cb5..ac04009d9 100644
--- a/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldtofieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToFieldMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -47,6 +49,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml b/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml
index 7a52ecbd8..b72af78d3 100644
--- a/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToFieldMultiMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToFieldMultiMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -49,6 +51,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml b/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml
index f703a4f92..705029e76 100644
--- a/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldToTagFieldMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToTagFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.fieldvaluemap.yaml b/docs/_data/reference.fieldmaps.fieldvaluemap.yaml
index 6330529fd..10a839a45 100644
--- a/docs/_data/reference.fieldmaps.fieldvaluemap.yaml
+++ b/docs/_data/reference.fieldmaps.fieldvaluemap.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldValueMapOptions
optionsClassFullName: MigrationTools.Tools.FieldValueMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldValueMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldValueMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml b/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml
index d596b737c..0f8006cdd 100644
--- a/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml
+++ b/docs/_data/reference.fieldmaps.multivalueconditionalmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: MultiValueConditionalMapOptions
optionsClassFullName: MigrationTools.Tools.MultiValueConditionalMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -52,6 +54,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.regexfieldmap.yaml b/docs/_data/reference.fieldmaps.regexfieldmap.yaml
index e2ed7b018..d02593fd8 100644
--- a/docs/_data/reference.fieldmaps.regexfieldmap.yaml
+++ b/docs/_data/reference.fieldmaps.regexfieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: RegexFieldMapOptions
optionsClassFullName: MigrationTools.Tools.RegexFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.RegexFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -48,6 +50,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.RegexFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.fieldmaps.treetotagfieldmap.yaml b/docs/_data/reference.fieldmaps.treetotagfieldmap.yaml
index 533cbd093..13f1e6209 100644
--- a/docs/_data/reference.fieldmaps.treetotagfieldmap.yaml
+++ b/docs/_data/reference.fieldmaps.treetotagfieldmap.yaml
@@ -2,6 +2,7 @@ optionsClassName: TreeToTagFieldMapOptions
optionsClassFullName: MigrationTools.Tools.TreeToTagFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,10 +24,12 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TreeToTagFieldMapOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.TreeToTagFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml b/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml
index 1cce83e27..0c418777f 100644
--- a/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml
+++ b/docs/_data/reference.processorenrichers.pauseaftereachitem.yaml
@@ -2,14 +2,17 @@ optionsClassName: PauseAfterEachItemOptions
optionsClassFullName: MigrationTools.Enrichers.PauseAfterEachItemOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Enrichers.PauseAfterEachItemOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Enrichers.PauseAfterEachItemOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml b/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml
index f60bff8a6..3b81ceab9 100644
--- a/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml
+++ b/docs/_data/reference.processors.azuredevopspipelineprocessor.yaml
@@ -2,6 +2,7 @@ optionsClassName: AzureDevOpsPipelineProcessorOptions
optionsClassFullName: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -26,6 +27,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -63,10 +66,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 +83,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 +103,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 d203675d1..75fab3d20 100644
--- a/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
+++ b/docs/_data/reference.processors.keepoutboundlinktargetprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: KeepOutboundLinkTargetProcessorOptions
optionsClassFullName: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -17,14 +20,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": "8e55d369-07c8-4e19-9313-fd2543544c73",
+ "TargetLinksToKeepProject": "35537ca4-fac4-4fe6-8dd1-62e6c6a0684d",
"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 +45,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..e6d9a98ef 100644
--- a/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml
+++ b/docs/_data/reference.processors.outboundlinkcheckingprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: OutboundLinkCheckingProcessorOptions
optionsClassFullName: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -17,10 +20,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 +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: 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..c9d5514a3 100644
--- a/docs/_data/reference.processors.processdefinitionprocessor.yaml
+++ b/docs/_data/reference.processors.processdefinitionprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: ProcessDefinitionProcessorOptions
optionsClassFullName: MigrationTools.Processors.ProcessDefinitionProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,10 +22,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 +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: MaxDegreeOfParallelism
type: Int32
description: missing XML code comments
@@ -50,10 +47,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..b9fb8df90 100644
--- a/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml
+++ b/docs/_data/reference.processors.tfsexportprofilepicturefromadprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsExportProfilePictureFromADProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,10 +22,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 +39,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 +47,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..aa59d2d0c 100644
--- a/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml
+++ b/docs/_data/reference.processors.tfsexportusersformappingprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsExportUsersForMappingProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -17,10 +20,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 +33,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..2dfeb08d7 100644
--- a/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml
+++ b/docs/_data/reference.processors.tfsimportprofilepictureprocessor.yaml
@@ -2,23 +2,24 @@ optionsClassName: TfsImportProfilePictureProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..69afccc25 100644
--- a/docs/_data/reference.processors.tfssharedqueryprocessor.yaml
+++ b/docs/_data/reference.processors.tfssharedqueryprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsSharedQueryProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsSharedQueryProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,10 +21,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 +34,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..a9349bbbf 100644
--- a/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml
+++ b/docs/_data/reference.processors.tfsteamsettingsprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsTeamSettingsProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,10 +23,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 +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: 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 +48,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..968646c69 100644
--- a/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml
+++ b/docs/_data/reference.processors.tfstestconfigurationsmigrationprocessor.yaml
@@ -2,23 +2,24 @@ optionsClassName: TfsTestConfigurationsMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..dce4cf7ab 100644
--- a/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml
+++ b/docs/_data/reference.processors.tfstestplansandsuitesmigrationprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsTestPlansAndSuitesMigrationProcessorOptions
optionsClassFullName: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -21,10 +24,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 +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: FilterCompleted
type: Boolean
description: missing XML code comments
@@ -52,10 +49,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..dbaefea61 100644
--- a/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml
+++ b/docs/_data/reference.processors.tfstestvariablesmigrationprocessor.yaml
@@ -2,24 +2,25 @@ optionsClassName: TfsTestVariablesMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +32,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..d30978e8e 100644
--- a/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml
+++ b/docs/_data/reference.processors.tfsworkitembulkeditprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsWorkItemBulkEditProcessorOptions
optionsClassFullName: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -21,10 +24,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 +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: 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 +45,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..420afd6a4 100644
--- a/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml
+++ b/docs/_data/reference.processors.tfsworkitemdeleteprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsWorkItemDeleteProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,10 +23,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 +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: FilterWorkItemsThatAlreadyExistInTarget
type: Boolean
description: missing XML code comments
@@ -47,10 +44,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..54bc6067e 100644
--- a/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml
+++ b/docs/_data/reference.processors.tfsworkitemmigrationprocessor.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsWorkItemMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -32,6 +33,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -40,28 +42,18 @@ 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"
}
]
}
}
sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -73,17 +65,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 +75,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 +86,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 +115,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..a8009e4f7 100644
--- a/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml
+++ b/docs/_data/reference.processors.tfsworkitemoverwriteareasastagsprocessor.yaml
@@ -2,24 +2,25 @@ optionsClassName: TfsWorkItemOverwriteAreasAsTagsProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..096b4abfe 100644
--- a/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml
+++ b/docs/_data/reference.processors.tfsworkitemoverwriteprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsWorkItemOverwriteProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,10 +23,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 +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: 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 +44,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..8d17cbf39 100644
--- a/docs/_data/reference.processors.workitemtrackingprocessor.yaml
+++ b/docs/_data/reference.processors.workitemtrackingprocessor.yaml
@@ -2,14 +2,17 @@ optionsClassName: WorkItemTrackingProcessorOptions
optionsClassFullName: MigrationTools.Processors.WorkItemTrackingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,10 +21,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 +38,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/_data/reference.tools.fieldmappingtool.yaml b/docs/_data/reference.tools.fieldmappingtool.yaml
index e159741e5..407ad565a 100644
--- a/docs/_data/reference.tools.fieldmappingtool.yaml
+++ b/docs/_data/reference.tools.fieldmappingtool.yaml
@@ -2,6 +2,7 @@ optionsClassName: FieldMappingToolOptions
optionsClassFullName: MigrationTools.Tools.FieldMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -22,6 +23,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -189,6 +191,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.stringmanipulatortool.yaml b/docs/_data/reference.tools.stringmanipulatortool.yaml
index 222170f31..43ef13990 100644
--- a/docs/_data/reference.tools.stringmanipulatortool.yaml
+++ b/docs/_data/reference.tools.stringmanipulatortool.yaml
@@ -2,6 +2,7 @@ optionsClassName: StringManipulatorToolOptions
optionsClassFullName: MigrationTools.Tools.StringManipulatorToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -26,6 +27,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.StringManipulatorToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.StringManipulatorToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsattachmenttool.yaml b/docs/_data/reference.tools.tfsattachmenttool.yaml
index 0481a7309..5f63321fe 100644
--- a/docs/_data/reference.tools.tfsattachmenttool.yaml
+++ b/docs/_data/reference.tools.tfsattachmenttool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsAttachmentToolOptions
optionsClassFullName: MigrationTools.Tools.TfsAttachmentToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -19,6 +20,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsAttachmentToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -36,6 +38,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsAttachmentToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfschangesetmappingtool.yaml b/docs/_data/reference.tools.tfschangesetmappingtool.yaml
index 6255630b4..cbfa4e7e6 100644
--- a/docs/_data/reference.tools.tfschangesetmappingtool.yaml
+++ b/docs/_data/reference.tools.tfschangesetmappingtool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsChangeSetMappingToolOptions
optionsClassFullName: MigrationTools.Tools.TfsChangeSetMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -17,6 +18,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsChangeSetMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -32,6 +34,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsChangeSetMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsembededimagestool.yaml b/docs/_data/reference.tools.tfsembededimagestool.yaml
index 6dc25a720..cbe503c35 100644
--- a/docs/_data/reference.tools.tfsembededimagestool.yaml
+++ b/docs/_data/reference.tools.tfsembededimagestool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsEmbededImagesToolOptions
optionsClassFullName: MigrationTools.Tools.TfsEmbededImagesToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -16,6 +17,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsEmbededImagesToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -30,6 +32,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsEmbededImagesToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsgitrepositorytool.yaml b/docs/_data/reference.tools.tfsgitrepositorytool.yaml
index e012b62b8..bcc99f6cc 100644
--- a/docs/_data/reference.tools.tfsgitrepositorytool.yaml
+++ b/docs/_data/reference.tools.tfsgitrepositorytool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsGitRepositoryToolOptions
optionsClassFullName: MigrationTools.Tools.TfsGitRepositoryToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -17,6 +18,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsGitRepositoryToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -34,6 +36,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsGitRepositoryToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsnodestructuretool.yaml b/docs/_data/reference.tools.tfsnodestructuretool.yaml
index f91c9e7ba..e296195b1 100644
--- a/docs/_data/reference.tools.tfsnodestructuretool.yaml
+++ b/docs/_data/reference.tools.tfsnodestructuretool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsNodeStructureToolOptions
optionsClassFullName: MigrationTools.Tools.TfsNodeStructureToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -26,6 +27,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsNodeStructureToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -63,6 +65,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsNodeStructureToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsrevisionmanagertool.yaml b/docs/_data/reference.tools.tfsrevisionmanagertool.yaml
index a790c2861..034a1d10d 100644
--- a/docs/_data/reference.tools.tfsrevisionmanagertool.yaml
+++ b/docs/_data/reference.tools.tfsrevisionmanagertool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsRevisionManagerToolOptions
optionsClassFullName: MigrationTools.Tools.TfsRevisionManagerToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -18,6 +19,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsRevisionManagerToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -34,6 +36,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsRevisionManagerToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsteamsettingstool.yaml b/docs/_data/reference.tools.tfsteamsettingstool.yaml
index 77f6a1816..43b14db48 100644
--- a/docs/_data/reference.tools.tfsteamsettingstool.yaml
+++ b/docs/_data/reference.tools.tfsteamsettingstool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsTeamSettingsToolOptions
optionsClassFullName: MigrationTools.Tools.TfsTeamSettingsToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -20,6 +21,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsTeamSettingsToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -41,6 +43,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsTeamSettingsToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsusermappingtool.yaml b/docs/_data/reference.tools.tfsusermappingtool.yaml
index 26b9c9d8f..21e992a85 100644
--- a/docs/_data/reference.tools.tfsusermappingtool.yaml
+++ b/docs/_data/reference.tools.tfsusermappingtool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsUserMappingToolOptions
optionsClassFullName: MigrationTools.Tools.TfsUserMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -25,6 +26,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsUserMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -48,6 +50,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsUserMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsvalidaterequiredfieldtool.yaml b/docs/_data/reference.tools.tfsvalidaterequiredfieldtool.yaml
index b7cd0840d..194b9de78 100644
--- a/docs/_data/reference.tools.tfsvalidaterequiredfieldtool.yaml
+++ b/docs/_data/reference.tools.tfsvalidaterequiredfieldtool.yaml
@@ -2,14 +2,17 @@ optionsClassName: TfsValidateRequiredFieldToolOptions
optionsClassFullName: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsworkitemembededlinktool.yaml b/docs/_data/reference.tools.tfsworkitemembededlinktool.yaml
index 119a80faa..2c06c3f3b 100644
--- a/docs/_data/reference.tools.tfsworkitemembededlinktool.yaml
+++ b/docs/_data/reference.tools.tfsworkitemembededlinktool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsWorkItemEmbededLinkToolOptions
optionsClassFullName: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -16,6 +17,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -30,6 +32,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.tfsworkitemlinktool.yaml b/docs/_data/reference.tools.tfsworkitemlinktool.yaml
index 2c8b790ef..7439af47e 100644
--- a/docs/_data/reference.tools.tfsworkitemlinktool.yaml
+++ b/docs/_data/reference.tools.tfsworkitemlinktool.yaml
@@ -2,6 +2,7 @@ optionsClassName: TfsWorkItemLinkToolOptions
optionsClassFullName: MigrationTools.Tools.TfsWorkItemLinkToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -18,6 +19,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemLinkToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -34,6 +36,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemLinkToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_data/reference.tools.workitemtypemappingtool.yaml b/docs/_data/reference.tools.workitemtypemappingtool.yaml
index ced01edfa..74881e764 100644
--- a/docs/_data/reference.tools.workitemtypemappingtool.yaml
+++ b/docs/_data/reference.tools.workitemtypemappingtool.yaml
@@ -2,6 +2,7 @@ optionsClassName: WorkItemTypeMappingToolOptions
optionsClassFullName: MigrationTools.Tools.WorkItemTypeMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -19,6 +20,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.WorkItemTypeMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -36,6 +38,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.WorkItemTypeMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/_layouts/reference.html b/docs/_layouts/reference.html
index 433fd81d1..1ed1a58ee 100644
--- a/docs/_layouts/reference.html
+++ b/docs/_layouts/reference.html
@@ -42,18 +42,27 @@ Options
Examples
- {% assign configurationSamples = page.configurationSamples %}
+ {% assign configurationSamples = page.configurationSamples | sort: "order" %}
{% for sample in configurationSamples %}
{{sample.name}}
- {% if sample.name == "Classic" %}
- We have moved to a new config format, but are still tying to get this here to generate :)! The sample below is generated and is still valid for the settings, but you will need to map it to the main format.
+ {% if sample.name == "classic" %}
+ We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.
+ {% endif %}
+ {% if sample.name == "defaults" %}
+ These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.
+ {% endif %}
+ {% if sample.name == "sample" %}
+ This is an example of what your config might look like once configured.
{% endif %}
{% highlight json linenos %}
{{sample.code}}
{% endhighlight %}
{% endfor %}
{% assign mdInfo = page.topics | where: "topic", "notes" | last %}
- {{ mdInfo.markdown | markdownify }}
+ {% capture processedContent %}
+ {{ mdInfo.markdown }}
+ {% endcapture %}
+ {{ processedContent | markdownify }}
{{ content | inject_anchors }}
diff --git a/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md b/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md
index 6f287688e..f1a5a3b68 100644
--- a/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.azuredevopsendpoint.md
@@ -3,10 +3,12 @@ optionsClassName: AzureDevOpsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -14,19 +16,19 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "AzureDevOpsEndpoint": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "EndpointType": "AzureDevOpsEndpoint",
- "Organisation": "https://dev.azure.com/xxx/",
- "Project": "myProject"
- }
+ "EndpointType": "AzureDevOpsEndpoint",
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "Organisation": "https://dev.azure.com/xxx/",
+ "Project": "myProject",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -35,8 +37,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
@@ -52,10 +53,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..1457e0dd2 100644
--- a/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.filesystemworkitemendpoint.md
@@ -3,20 +3,22 @@ optionsClassName: FileSystemWorkItemEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
"$type": "FileSystemWorkItemEndpointOptions",
- "FileStore": null,
- "EndpointEnrichers": null
+ "FileStore": null
}
sampleFor: MigrationTools.Endpoints.FileSystemWorkItemEndpointOptions
description: missing XML code comments
@@ -24,10 +26,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 54535a75a..b876b9ce8 100644
--- a/docs/collections/_reference/reference.endpoints.tfsendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.tfsendpoint.md
@@ -3,6 +3,7 @@ optionsClassName: TfsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -10,32 +11,32 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
"AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -43,31 +44,31 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "migrationSource1",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -83,13 +84,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
@@ -97,10 +96,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
@@ -109,10 +104,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 ae441a662..fdfed068d 100644
--- a/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.tfsteamprojectendpoint.md
@@ -3,6 +3,7 @@ optionsClassName: TfsTeamProjectEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -10,32 +11,32 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "",
"AuthenticationMode": "AccessToken",
- "Collection": "",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": ""
- }
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "AuthenticationMode": "AccessToken",
+ "Collection": "",
+ "LanguageMaps": {
+ "AreaPath": "Area",
+ "IterationPath": "Iteration"
+ },
+ "Project": "",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -43,31 +44,27 @@ configurationSamples:
"Version": "16.0",
"Endpoints": {
"#KEY#": {
- "TfsTeamProjectEndpoint": {
- "AllowCrossProjectLinking": "False",
- "Authentication": {
- "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
- "AuthenticationMode": "AccessToken",
- "NetworkCredentials": {
- "Domain": "",
- "Password": "",
- "UserName": ""
- }
- },
- "Collection": "https://dev.azure.com/nkdagility-preview/",
- "EndpointType": "TfsTeamProjectEndpoint",
- "LanguageMaps": {
- "AreaPath": "Area",
- "IterationPath": "Iteration"
- },
- "Project": "migrationSource1"
- }
+ "EndpointType": "TfsTeamProjectEndpoint",
+ "AllowCrossProjectLinking": "False",
+ "Authentication": {
+ "AccessToken": "jklsadhjksahfkjsdhjksahsadjhksadhsad",
+ "AuthenticationMode": "AccessToken",
+ "NetworkCredentials": {
+ "Domain": "",
+ "Password": "",
+ "UserName": ""
+ }
+ },
+ "Collection": "https://dev.azure.com/nkdagility-preview/",
+ "Project": "migrationSource1",
+ "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
}
}
}
}
sampleFor: MigrationTools.Endpoints.TfsTeamProjectEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -83,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.TfsTeamProjectEndpointOptions
description: missing XML code comments
@@ -97,10 +92,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
@@ -109,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/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md b/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md
index a3d76a7e8..bd515631b 100644
--- a/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.tfsteamsettingsendpoint.md
@@ -3,14 +3,17 @@ optionsClassName: TfsTeamSettingsEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.TfsTeamSettingsEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,9 +22,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 +33,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 +41,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..42f0848ce 100644
--- a/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md
+++ b/docs/collections/_reference/reference.endpoints.tfsworkitemendpoint.md
@@ -3,14 +3,17 @@ optionsClassName: TfsWorkItemEndpointOptions
optionsClassFullName: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Endpoints.TfsWorkItemEndpointOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,9 +23,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 +34,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 +42,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.fieldmaps.fieldclearmap.md b/docs/collections/_reference/reference.fieldmaps.fieldclearmap.md
index 79b889cb1..105608355 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldclearmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldclearmap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldClearMapOptions
optionsClassFullName: MigrationTools.Tools.FieldClearMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -46,6 +48,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldClearMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldliteralmap.md b/docs/collections/_reference/reference.fieldmaps.fieldliteralmap.md
index dfda3b394..7fcdcc30f 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldliteralmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldliteralmap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldLiteralMapOptions
optionsClassFullName: MigrationTools.Tools.FieldLiteralMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -47,6 +49,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldmergemap.md b/docs/collections/_reference/reference.fieldmaps.fieldmergemap.md
index 5407e5a88..82f3e9b30 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldmergemap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldmergemap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldMergeMapOptions
optionsClassFullName: MigrationTools.Tools.FieldMergeMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -51,6 +53,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMergeMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldskipmap.md b/docs/collections/_reference/reference.fieldmaps.fieldskipmap.md
index 6e0cab679..4e3d84792 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldskipmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldskipmap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldSkipMapOptions
optionsClassFullName: MigrationTools.Tools.FieldSkipMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,10 +25,12 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.FieldSkipMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldtofieldmap.md b/docs/collections/_reference/reference.fieldmaps.fieldtofieldmap.md
index c947391bc..af06378f9 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldtofieldmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldtofieldmap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldToFieldMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -48,6 +50,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldtofieldmultimap.md b/docs/collections/_reference/reference.fieldmaps.fieldtofieldmultimap.md
index 5184ca6a7..87fe4fb47 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldtofieldmultimap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldtofieldmultimap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldToFieldMultiMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToFieldMultiMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -50,6 +52,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToFieldMultiMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldtotagfieldmap.md b/docs/collections/_reference/reference.fieldmaps.fieldtotagfieldmap.md
index 60012f22b..bbaf965a6 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldtotagfieldmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldtotagfieldmap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldToTagFieldMapOptions
optionsClassFullName: MigrationTools.Tools.FieldToTagFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -51,6 +53,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldToTagFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.fieldvaluemap.md b/docs/collections/_reference/reference.fieldmaps.fieldvaluemap.md
index c78ee6e09..42abcc1bd 100644
--- a/docs/collections/_reference/reference.fieldmaps.fieldvaluemap.md
+++ b/docs/collections/_reference/reference.fieldmaps.fieldvaluemap.md
@@ -3,6 +3,7 @@ optionsClassName: FieldValueMapOptions
optionsClassFullName: MigrationTools.Tools.FieldValueMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldValueMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -51,6 +53,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldValueMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.multivalueconditionalmap.md b/docs/collections/_reference/reference.fieldmaps.multivalueconditionalmap.md
index b6b883297..40c263f06 100644
--- a/docs/collections/_reference/reference.fieldmaps.multivalueconditionalmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.multivalueconditionalmap.md
@@ -3,6 +3,7 @@ optionsClassName: MultiValueConditionalMapOptions
optionsClassFullName: MigrationTools.Tools.MultiValueConditionalMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -53,6 +55,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.MultiValueConditionalMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.regexfieldmap.md b/docs/collections/_reference/reference.fieldmaps.regexfieldmap.md
index 1e1a94753..84da66e9d 100644
--- a/docs/collections/_reference/reference.fieldmaps.regexfieldmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.regexfieldmap.md
@@ -3,6 +3,7 @@ optionsClassName: RegexFieldMapOptions
optionsClassFullName: MigrationTools.Tools.RegexFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,6 +25,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.RegexFieldMapOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -49,6 +51,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.RegexFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.fieldmaps.treetotagfieldmap.md b/docs/collections/_reference/reference.fieldmaps.treetotagfieldmap.md
index 9184da967..e5ada12d0 100644
--- a/docs/collections/_reference/reference.fieldmaps.treetotagfieldmap.md
+++ b/docs/collections/_reference/reference.fieldmaps.treetotagfieldmap.md
@@ -3,6 +3,7 @@ optionsClassName: TreeToTagFieldMapOptions
optionsClassFullName: MigrationTools.Tools.TreeToTagFieldMapOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -24,10 +25,12 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TreeToTagFieldMapOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.TreeToTagFieldMapOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.processorenrichers.pauseaftereachitem.md b/docs/collections/_reference/reference.processorenrichers.pauseaftereachitem.md
index 77042d75a..cfda69c2a 100644
--- a/docs/collections/_reference/reference.processorenrichers.pauseaftereachitem.md
+++ b/docs/collections/_reference/reference.processorenrichers.pauseaftereachitem.md
@@ -3,14 +3,17 @@ optionsClassName: PauseAfterEachItemOptions
optionsClassFullName: MigrationTools.Enrichers.PauseAfterEachItemOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Enrichers.PauseAfterEachItemOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Enrichers.PauseAfterEachItemOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md b/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md
index eb5fd995b..913b61b90 100644
--- a/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md
+++ b/docs/collections/_reference/reference.processors.azuredevopspipelineprocessor.md
@@ -3,6 +3,7 @@ optionsClassName: AzureDevOpsPipelineProcessorOptions
optionsClassFullName: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -27,6 +28,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -51,6 +53,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.AzureDevOpsPipelineProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -64,10 +67,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 +84,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 +104,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 a11c664c9..9bf6d032b 100644
--- a/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md
+++ b/docs/collections/_reference/reference.processors.keepoutboundlinktargetprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: KeepOutboundLinkTargetProcessorOptions
optionsClassFullName: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.KeepOutboundLinkTargetProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,14 +21,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": "8e55d369-07c8-4e19-9313-fd2543544c73",
+ "TargetLinksToKeepProject": "35537ca4-fac4-4fe6-8dd1-62e6c6a0684d",
"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 +46,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..d2a5fdda0 100644
--- a/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md
+++ b/docs/collections/_reference/reference.processors.outboundlinkcheckingprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: OutboundLinkCheckingProcessorOptions
optionsClassFullName: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Clients.AzureDevops.Rest.Processors.OutboundLinkCheckingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,10 +21,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 +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: 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..d499aaaf3 100644
--- a/docs/collections/_reference/reference.processors.processdefinitionprocessor.md
+++ b/docs/collections/_reference/reference.processors.processdefinitionprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: ProcessDefinitionProcessorOptions
optionsClassFullName: MigrationTools.Processors.ProcessDefinitionProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.ProcessDefinitionProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,10 +23,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 +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: MaxDegreeOfParallelism
type: Int32
description: missing XML code comments
@@ -51,10 +48,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..c494bd492 100644
--- a/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsexportprofilepicturefromadprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsExportProfilePictureFromADProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsExportProfilePictureFromADProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -20,10 +23,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 +40,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 +48,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..291686e94 100644
--- a/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsexportusersformappingprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsExportUsersForMappingProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsExportUsersForMappingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -18,10 +21,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 +34,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..e803c8534 100644
--- a/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsimportprofilepictureprocessor.md
@@ -3,23 +3,24 @@ optionsClassName: TfsImportProfilePictureProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsImportProfilePictureProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..3027b6cf3 100644
--- a/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfssharedqueryprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsSharedQueryProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsSharedQueryProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsSharedQueryProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,10 +22,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 +35,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..6332a9082 100644
--- a/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsteamsettingsprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsTeamSettingsProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTeamSettingsProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -21,10 +24,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 +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: 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 +49,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..d92d0b5f3 100644
--- a/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfstestconfigurationsmigrationprocessor.md
@@ -3,23 +3,24 @@ optionsClassName: TfsTestConfigurationsMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTestConfigurationsMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..985fd2a1f 100644
--- a/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfstestplansandsuitesmigrationprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsTestPlansAndSuitesMigrationProcessorOptions
optionsClassFullName: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsTestPlansAndSuitesMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -22,10 +25,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 +38,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 +50,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.
@@ -94,8 +87,56 @@ categories:
topics:
- topic: notes
path: /docs/Reference/Processors/TfsTestPlansAndSuitesMigrationProcessor-notes.md
- exists: false
- markdown: ''
+ exists: true
+ markdown: >2-
+
+ ## Additional Samples & Info
+
+
+ To run a full plans and suits you should run the three processors in this order below. `TestVariablesMigrationConfig` and `TestConfigurationsMigrationConfig` only need run once.
+
+
+ ```json
+
+ "Processors": [
+ {
+ "$type": "TestVariablesMigrationConfig",
+ "Enabled": false
+ },
+ {
+ "$type": "TestConfigurationsMigrationConfig",
+ "Enabled": true
+ },
+ {
+ "$type": "TestPlansAndSuitesMigrationConfig",
+ "Enabled": true,
+ "PrefixProjectToNodes": false,
+ "OnlyElementsWithTag": null,
+ "TestPlanQueryBit": null,
+ "RemoveAllLinks": false,
+ "MigrationDelay": 0,
+ "UseCommonNodeStructureEnricherConfig": false,
+ "NodeBasePaths": [],
+ "AreaMaps": null,
+ "IterationMaps": null,
+ "RemoveInvalidTestSuiteLinks": false,
+ "FilterCompleted": false
+ }
+ ]
+
+ ```
+
+ ## Known working TestPlanQueryBit filter fields names
+
+
+ `AreaPath`, `PlanName` and `PlanState`
+
+
+ ```json
+
+ "TestPlanQueryBit": "PlanName = 'ABC'"
+
+ ```
- topic: introduction
path: /docs/Reference/Processors/TfsTestPlansAndSuitesMigrationProcessor-introduction.md
exists: false
diff --git a/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md b/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md
index b83e7ca03..d16ea39b3 100644
--- a/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfstestvariablesmigrationprocessor.md
@@ -3,24 +3,25 @@ optionsClassName: TfsTestVariablesMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsTestVariablesMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +33,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..1dd9239ea 100644
--- a/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsworkitembulkeditprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsWorkItemBulkEditProcessorOptions
optionsClassFullName: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools._EngineV1.Configuration.Processing.TfsWorkItemBulkEditProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -22,10 +25,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 +38,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 +46,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..fb8130034 100644
--- a/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsworkitemdeleteprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsWorkItemDeleteProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemDeleteProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -21,10 +24,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 +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: FilterWorkItemsThatAlreadyExistInTarget
type: Boolean
description: missing XML code comments
@@ -48,10 +45,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..f25084647 100644
--- a/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsworkitemmigrationprocessor.md
@@ -3,6 +3,7 @@ optionsClassName: TfsWorkItemMigrationProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -33,6 +34,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -41,28 +43,18 @@ 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"
}
]
}
}
sampleFor: MigrationTools.Processors.TfsWorkItemMigrationProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -74,17 +66,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 +76,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 +87,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 +116,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
@@ -181,11 +133,115 @@ categories:
topics:
- topic: notes
path: /docs/Reference/Processors/TfsWorkItemMigrationProcessor-notes.md
- exists: false
- markdown: ''
+ exists: true
+ markdown: >+
+ ## WIQL Query
+
+
+ The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query.
+
+
+ > Note: A useful Azure DevOps Extension to explore WIQL is the [WIQL Editor](https://marketplace.visualstudio.com/items?itemName=ottostreifel.wiql-editor)
+
+
+ ### Examples
+
+
+ You can use the [WIQL Editor](https://marketplace.visualstudio.com/items?itemName=ottostreifel.wiql-editor) to craft a query in Azure DevOps.
+
+
+ A simple example config:
+
+
+ ```
+
+ "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"
+
+ ```
+
+ Scope to Area Path (Team data):
+
+
+ ```
+
+ "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.AreaPath] UNDER 'project\Team 1\' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
+
+ ```
+
+
+ ## NodeBasePath Configuration
+
+
+ Moved to the TfsNodeStructure
+
+
+ # Iteration Maps and Area Maps
+
+
+ Moved to the TfsNodeStructure
+
+
+
+
+ ## More Complex Team Migrations
+
+ The above options allow you to bring over a sub-set of the WIs (using the `WIQLQueryBit`) and move their area or iteration path to a default location. However you may wish to do something more complex e.g. re-map the team structure. This can be done with addition of a `FieldMaps` block to configuration in addition to the `NodeBasePaths`.
+
+
+ Using the above sample structure, if you wanted to map the source project `Team 1` to target project `Team A` etc. you could add the field map as follows
+
+
+ A complete list of [FieldMaps](../Reference/FieldMaps/index.md) are available.
+
+
+ ```
+ "FieldMaps": [
+ {
+ "$type": "FieldValueMapConfig",
+ "WorkItemTypeName": "*",
+ "sourceField": "System.AreaPath",
+ "targetField": "System.AreaPath",
+ "defaultValue": "TargetProg",
+ "valueMapping": {
+ "SampleProj\\Team 1": "TargetProg\\Team A",
+ "SampleProj\\Team 2": "TargetProg\\Team B"
+ "SampleProj\\Team 3": "TargetProg\\Team C"
+ }
+ },
+ ],
+
+ ```
+
+
+ > Note: This mappings could also be achieved with other forms of Field mapper e.g. `RegexFieldMapConfig`, but the value mapper as an example is easy to understand
+
+
+ # Removed Properties
+
+
+ - PrefixProjectToNodes - This option was removed in favour of the Area and Iteration Maps on [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)
- topic: introduction
path: /docs/Reference/Processors/TfsWorkItemMigrationProcessor-introduction.md
- exists: false
- markdown: ''
+ exists: true
+ markdown: >+
+ The `WorkItemMigrationContext` processor is used for migrating work items from one Azure DevOps instance to another. This encompasses a variety of activities:
+
+
+ 1. **Transferring Work Items Between Instances**: The primary purpose of the processor is to transfer work items, including bugs, tasks, user stories, features, and more, from one Azure DevOps instance to another.
+
+
+ 2. **Migrating Work Item History**: The processor can also replicate the entire revision history of work items, providing continuity and maintaining a record of changes.
+
+
+ 3. **Migrating Attachments and Links**: The processor can transfer any attachments or links associated with work items. This includes both external links and internal links to other work items.
+
+
+ 4. **Updating Metadata**: If configured, the processor can update the "Created Date" and "Created By" fields on migrated work items to match the original items in the source instance.
+
+
+ 5. **Filtering Work Items**: The processor can be configured to only migrate certain work items based on their area or iteration paths.
+
+
+ Overall, the `WorkItemMigrationContext` processor is a comprehensive tool for transferring work items and their associated data and metadata between Azure DevOps instances. It should be used whenever there is a need to move work items between instances while preserving as much information as possible.
---
\ No newline at end of file
diff --git a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md
index 4d75e7b60..b26bd86e8 100644
--- a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteareasastagsprocessor.md
@@ -3,24 +3,25 @@ optionsClassName: TfsWorkItemOverwriteAreasAsTagsProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteAreasAsTagsProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
"$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 +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: 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..2f0f651fa 100644
--- a/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md
+++ b/docs/collections/_reference/reference.processors.tfsworkitemoverwriteprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: TfsWorkItemOverwriteProcessorOptions
optionsClassFullName: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.TfsWorkItemOverwriteProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -21,10 +24,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 +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: 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 +45,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..4f968c072 100644
--- a/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md
+++ b/docs/collections/_reference/reference.processors.workitemtrackingprocessor.md
@@ -3,14 +3,17 @@ optionsClassName: WorkItemTrackingProcessorOptions
optionsClassFullName: MigrationTools.Processors.WorkItemTrackingProcessorOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Processors.WorkItemTrackingProcessorOptions
- name: classic
+ order: 3
description:
code: >-
{
@@ -19,10 +22,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 +39,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.tools.fieldmappingtool.md b/docs/collections/_reference/reference.tools.fieldmappingtool.md
index e0ab712f2..b49db683f 100644
--- a/docs/collections/_reference/reference.tools.fieldmappingtool.md
+++ b/docs/collections/_reference/reference.tools.fieldmappingtool.md
@@ -3,6 +3,7 @@ optionsClassName: FieldMappingToolOptions
optionsClassFullName: MigrationTools.Tools.FieldMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -23,6 +24,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -190,6 +192,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.FieldMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.stringmanipulatortool.md b/docs/collections/_reference/reference.tools.stringmanipulatortool.md
index 070f32c1e..b837a3814 100644
--- a/docs/collections/_reference/reference.tools.stringmanipulatortool.md
+++ b/docs/collections/_reference/reference.tools.stringmanipulatortool.md
@@ -3,6 +3,7 @@ optionsClassName: StringManipulatorToolOptions
optionsClassFullName: MigrationTools.Tools.StringManipulatorToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -27,6 +28,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.StringManipulatorToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -51,6 +53,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.StringManipulatorToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsattachmenttool.md b/docs/collections/_reference/reference.tools.tfsattachmenttool.md
index 04ff3d87f..42099a09a 100644
--- a/docs/collections/_reference/reference.tools.tfsattachmenttool.md
+++ b/docs/collections/_reference/reference.tools.tfsattachmenttool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsAttachmentToolOptions
optionsClassFullName: MigrationTools.Tools.TfsAttachmentToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -20,6 +21,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsAttachmentToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -37,6 +39,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsAttachmentToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfschangesetmappingtool.md b/docs/collections/_reference/reference.tools.tfschangesetmappingtool.md
index 23488d03d..95b8ef3cd 100644
--- a/docs/collections/_reference/reference.tools.tfschangesetmappingtool.md
+++ b/docs/collections/_reference/reference.tools.tfschangesetmappingtool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsChangeSetMappingToolOptions
optionsClassFullName: MigrationTools.Tools.TfsChangeSetMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -18,6 +19,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsChangeSetMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -33,6 +35,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsChangeSetMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsembededimagestool.md b/docs/collections/_reference/reference.tools.tfsembededimagestool.md
index ecc2fd1f3..4cc6d2221 100644
--- a/docs/collections/_reference/reference.tools.tfsembededimagestool.md
+++ b/docs/collections/_reference/reference.tools.tfsembededimagestool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsEmbededImagesToolOptions
optionsClassFullName: MigrationTools.Tools.TfsEmbededImagesToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -17,6 +18,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsEmbededImagesToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -31,6 +33,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsEmbededImagesToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsgitrepositorytool.md b/docs/collections/_reference/reference.tools.tfsgitrepositorytool.md
index aa2235c75..a745f98f6 100644
--- a/docs/collections/_reference/reference.tools.tfsgitrepositorytool.md
+++ b/docs/collections/_reference/reference.tools.tfsgitrepositorytool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsGitRepositoryToolOptions
optionsClassFullName: MigrationTools.Tools.TfsGitRepositoryToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -18,6 +19,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsGitRepositoryToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -35,6 +37,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsGitRepositoryToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsnodestructuretool.md b/docs/collections/_reference/reference.tools.tfsnodestructuretool.md
index a274babd8..1b971fc92 100644
--- a/docs/collections/_reference/reference.tools.tfsnodestructuretool.md
+++ b/docs/collections/_reference/reference.tools.tfsnodestructuretool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsNodeStructureToolOptions
optionsClassFullName: MigrationTools.Tools.TfsNodeStructureToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -27,6 +28,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsNodeStructureToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -64,6 +66,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsNodeStructureToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsrevisionmanagertool.md b/docs/collections/_reference/reference.tools.tfsrevisionmanagertool.md
index 8e6432a90..5c33f5264 100644
--- a/docs/collections/_reference/reference.tools.tfsrevisionmanagertool.md
+++ b/docs/collections/_reference/reference.tools.tfsrevisionmanagertool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsRevisionManagerToolOptions
optionsClassFullName: MigrationTools.Tools.TfsRevisionManagerToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -19,6 +20,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsRevisionManagerToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -35,6 +37,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsRevisionManagerToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsteamsettingstool.md b/docs/collections/_reference/reference.tools.tfsteamsettingstool.md
index f7719597f..24d698267 100644
--- a/docs/collections/_reference/reference.tools.tfsteamsettingstool.md
+++ b/docs/collections/_reference/reference.tools.tfsteamsettingstool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsTeamSettingsToolOptions
optionsClassFullName: MigrationTools.Tools.TfsTeamSettingsToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -21,6 +22,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsTeamSettingsToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -42,6 +44,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsTeamSettingsToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsusermappingtool.md b/docs/collections/_reference/reference.tools.tfsusermappingtool.md
index 5d73a461a..9745565ff 100644
--- a/docs/collections/_reference/reference.tools.tfsusermappingtool.md
+++ b/docs/collections/_reference/reference.tools.tfsusermappingtool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsUserMappingToolOptions
optionsClassFullName: MigrationTools.Tools.TfsUserMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -26,6 +27,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsUserMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -49,6 +51,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsUserMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsvalidaterequiredfieldtool.md b/docs/collections/_reference/reference.tools.tfsvalidaterequiredfieldtool.md
index bcb6c0d52..6c202ce80 100644
--- a/docs/collections/_reference/reference.tools.tfsvalidaterequiredfieldtool.md
+++ b/docs/collections/_reference/reference.tools.tfsvalidaterequiredfieldtool.md
@@ -3,14 +3,17 @@ optionsClassName: TfsValidateRequiredFieldToolOptions
optionsClassFullName: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: There are no defaults! Check the sample for options!
sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
- name: sample
+ order: 1
description:
code: There is no sample, but you can check the classic below for a general feel.
sampleFor: MigrationTools.Tools.TfsValidateRequiredFieldToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsworkitemembededlinktool.md b/docs/collections/_reference/reference.tools.tfsworkitemembededlinktool.md
index 1eb050288..38e4122d0 100644
--- a/docs/collections/_reference/reference.tools.tfsworkitemembededlinktool.md
+++ b/docs/collections/_reference/reference.tools.tfsworkitemembededlinktool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsWorkItemEmbededLinkToolOptions
optionsClassFullName: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -17,6 +18,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -31,6 +33,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemEmbededLinkToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.tfsworkitemlinktool.md b/docs/collections/_reference/reference.tools.tfsworkitemlinktool.md
index abfb7ced2..4b5ad2fc7 100644
--- a/docs/collections/_reference/reference.tools.tfsworkitemlinktool.md
+++ b/docs/collections/_reference/reference.tools.tfsworkitemlinktool.md
@@ -3,6 +3,7 @@ optionsClassName: TfsWorkItemLinkToolOptions
optionsClassFullName: MigrationTools.Tools.TfsWorkItemLinkToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -19,6 +20,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemLinkToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -35,6 +37,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.TfsWorkItemLinkToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/docs/collections/_reference/reference.tools.workitemtypemappingtool.md b/docs/collections/_reference/reference.tools.workitemtypemappingtool.md
index 54ad0db00..88fae7ad2 100644
--- a/docs/collections/_reference/reference.tools.workitemtypemappingtool.md
+++ b/docs/collections/_reference/reference.tools.workitemtypemappingtool.md
@@ -3,6 +3,7 @@ optionsClassName: WorkItemTypeMappingToolOptions
optionsClassFullName: MigrationTools.Tools.WorkItemTypeMappingToolOptions
configurationSamples:
- name: defaults
+ order: 2
description:
code: >-
{
@@ -20,6 +21,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.WorkItemTypeMappingToolOptions
- name: sample
+ order: 1
description:
code: >-
{
@@ -37,6 +39,7 @@ configurationSamples:
}
sampleFor: MigrationTools.Tools.WorkItemTypeMappingToolOptions
- name: classic
+ order: 3
description:
code: >-
{
diff --git a/src/MigrationTools.Clients.TfsObjectModel/EndPoints/Infrastructure/TfsTeamProjectAuthentication.cs b/src/MigrationTools.Clients.TfsObjectModel/EndPoints/Infrastructure/TfsTeamProjectAuthentication.cs
index a198afa8b..55c5b68ab 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/EndPoints/Infrastructure/TfsTeamProjectAuthentication.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/EndPoints/Infrastructure/TfsTeamProjectAuthentication.cs
@@ -17,6 +17,7 @@ public class TfsAuthenticationOptions : IValidateOptions), "** removed as a secret ***")]
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs
index 0f36e7dc0..8408717c8 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpointOptions.cs
@@ -2,6 +2,7 @@
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
+using System.Text.Encodings.Web;
using Microsoft.Extensions.Options;
using MigrationTools.Endpoints.Infrastructure;
using Newtonsoft.Json;
@@ -25,10 +26,13 @@ public class TfsEndpointOptions : EndpointOptions
[JsonProperty(Order = -1)]
[Required]
public string ReflectedWorkItemIdField { get; set; }
- public bool AllowCrossProjectLinking { get; set; }
+
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool AllowCrossProjectLinking { get; set; } = false;
[Required]
- public TfsLanguageMapOptions LanguageMaps { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public TfsLanguageMapOptions LanguageMaps { get; set; } = new TfsLanguageMapOptions() { AreaPath = "Area", IterationPath = "Iteration" };
}
public class TfsEndpointOptionsValidator : IValidateOptions
@@ -42,9 +46,14 @@ public ValidateOptionsResult Validate(string name, TfsEndpointOptions options)
{
errors.Add("The Collection property must not be null.");
}
- else if (!Uri.IsWellFormedUriString(options.Collection.ToString(), UriKind.Absolute))
+ else
{
- errors.Add("The Collection property must be a valid URL.");
+ Uri output;
+ if (!Uri.TryCreate(Uri.UnescapeDataString(options.Collection.ToString()), UriKind.Absolute, out output))
+ {
+ errors.Add("The Collection property must be a valid URL.");
+ }
+
}
// Validate Project - Must not be null or empty
@@ -66,7 +75,7 @@ public ValidateOptionsResult Validate(string name, TfsEndpointOptions options)
}
else
{
- ValidateOptionsResult lmr= options.LanguageMaps.Validate(name, options.LanguageMaps);
+ ValidateOptionsResult lmr = options.LanguageMaps.Validate(name, options.LanguageMaps);
if (lmr != ValidateOptionsResult.Success)
{
errors.AddRange(lmr.Failures);
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs
index 970a97665..3e729be72 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemMigrationProcessorOptions.cs
@@ -7,6 +7,7 @@
using Microsoft.Extensions.Options;
using System.Text.RegularExpressions;
using System.DirectoryServices.AccountManagement;
+using Newtonsoft.Json;
namespace MigrationTools.Processors
{
@@ -21,7 +22,8 @@ public class TfsWorkItemMigrationProcessorOptions : ProcessorOptions, IWorkItemP
/// not the internal create date)
///
/// true
- public bool UpdateCreatedDate { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool UpdateCreatedDate { get; set; } = true;
///
/// If this is enabled the creation process on the target project will create the items with the original creation date.
@@ -29,7 +31,8 @@ public class TfsWorkItemMigrationProcessorOptions : ProcessorOptions, IWorkItemP
/// not the internal create date)
///
/// true
- public bool UpdateCreatedBy { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool UpdateCreatedBy { get; set; } = true;
///
@@ -44,15 +47,17 @@ public class TfsWorkItemMigrationProcessorOptions : ProcessorOptions, IWorkItemP
/// fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps;
/// TFS should use integrated authentication.
///
- /// ?
- public bool FixHtmlAttachmentLinks { get; set; }
+ /// true
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool FixHtmlAttachmentLinks { get; set; } = true;
///
/// **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.
///
/// 5
- public int WorkItemCreateRetryLimit { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public int WorkItemCreateRetryLimit { get; set; } = 5;
///
/// 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.
@@ -65,24 +70,28 @@ public class TfsWorkItemMigrationProcessorOptions : ProcessorOptions, IWorkItemP
/// Pause after each work item is migrated
///
/// false
- public bool PauseAfterEachWorkItem { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool PauseAfterEachWorkItem { get; set; } = false;
///
/// This will create a json file with the revision history and attach it to the work item. Best used with `MaxRevisions` or `ReplayRevisions`.
///
- /// ?
- public bool AttachRevisionHistory { get; set; }
+ /// false
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool AttachRevisionHistory { get; set; } = false;
///
/// If enabled, adds a comment recording the migration
///
- /// false
- public bool GenerateMigrationComment { get; set; }
+ /// true
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool GenerateMigrationComment { get; set; } = true;
///
/// A list of work items to import
///
/// []
+ [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public IList WorkItemIDs { get; set; }
///
@@ -90,17 +99,20 @@ public class TfsWorkItemMigrationProcessorOptions : ProcessorOptions, IWorkItemP
/// continue until the number of failed items reaches the configured value, after which the migration fails.
///
/// 0
- public int MaxGracefulFailures { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public int MaxGracefulFailures { get; set; } = 0;
///
/// This will skip a revision if the source iteration has not been migrated i.e. it was deleted
///
- public bool SkipRevisionWithInvalidIterationPath { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool SkipRevisionWithInvalidIterationPath { get; set; } = false;
///
/// 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.
///
- public bool SkipRevisionWithInvalidAreaPath { get; set; }
+ [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+ public bool SkipRevisionWithInvalidAreaPath { get; set; } = false;
}
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryTool.cs
index 39144fd86..2ae331e08 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryTool.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryTool.cs
@@ -78,6 +78,11 @@ public int Enrich(TfsProcessor processor, WorkItemData sourceWorkItem, WorkItem
{
throw new ArgumentNullException(nameof(targetWorkItem));
}
+ if (!Options.Enabled)
+ {
+ Log.LogWarning("TfsGitRepositoryEnricher is not enabled! We will not fix any git commit links in Work items and they will be ignored.");
+ return 0;
+ }
Log.LogInformation("GitRepositoryEnricher: Enriching {Id} To fix Git Repo Links", targetWorkItem.Id);
var changeSetMappings = Services.GetService();
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptions.cs
index ca248b643..b41a87d51 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptions.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptions.cs
@@ -1,5 +1,8 @@
using System;
using System.Collections.Generic;
+using DotNet.Globbing;
+using Microsoft.Extensions.Options;
+using System.Text.RegularExpressions;
using Microsoft.TeamFoundation.Build.Client;
using MigrationTools.Enrichers;
using MigrationTools.Tools.Infrastructure;
@@ -12,6 +15,7 @@ public class TfsGitRepositoryToolOptions : ToolOptions
/// List of work item mappings.
///
/// {}
- public Dictionary Mappings { get; set; }
+ public Dictionary Mappings { get; set; } = new Dictionary();
}
+
}
\ No newline at end of file
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptionsValidator.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptionsValidator.cs
new file mode 100644
index 000000000..751557840
--- /dev/null
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsGitRepositoryToolOptionsValidator.cs
@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Options;
+
+namespace MigrationTools.Tools
+{
+ internal class TfsGitRepositoryToolOptionsValidator : IValidateOptions
+ {
+ public ValidateOptionsResult Validate(string name, TfsGitRepositoryToolOptions options)
+ {
+ if (options.Mappings == null)
+ {
+ return ValidateOptionsResult.Fail("Mappings must be set to at least an empty array");
+ }
+ return ValidateOptionsResult.Success;
+ }
+ }
+}
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsNodeStructureTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsNodeStructureTool.cs
index cfc4f8215..11382c0c3 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsNodeStructureTool.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsNodeStructureTool.cs
@@ -14,6 +14,7 @@
using MigrationTools.DataContracts;
using MigrationTools.Endpoints;
using MigrationTools.Enrichers;
+using MigrationTools.Exceptions;
using MigrationTools.FieldMaps;
using MigrationTools.Processors;
using MigrationTools.Processors.Infrastructure;
@@ -108,7 +109,7 @@ public string GetNewNodeName(string sourceNodePath, TfsNodeStructureType nodeStr
Log.LogWarning("nodeStructureEnricher is disabled! You may get migration errors!");
return sourceNodePath;
}
- var mappers = GetMaps(nodeStructureType);
+ var mappers = GetMaps(nodeStructureType);
var lastResortRule = GetLastResortRemappingRule();
Log.LogDebug("NodeStructureEnricher.GetNewNodeName::Mappers", mappers);
@@ -424,9 +425,8 @@ private string GetLocalizedNodeStructureTypeName(TfsNodeStructureType value, Tfs
case TfsNodeStructureType.Iteration:
return languageMap.IterationPath.IsNullOrEmpty() ? "Iteration" : languageMap.IterationPath;
-
default:
- throw new InvalidOperationException("Not a valid NodeStructureType ");
+ throw new InvalidOperationException("Not a valid NodeStructureType ").AsMigrationToolsException(MigrationToolsException.ExceptionSource.Internal);
}
}
@@ -450,7 +450,7 @@ private void ProcessCommonStructure(string treeTypeSource, string localizedTreeT
{
Exception ex = new Exception(string.Format("Unable to load Common Structure for Source. This is usually due to different language versions. Validate that '{0}' is the correct name in your version. ", treeTypeSource));
Log.LogError(ex, "Unable to load Common Structure for Source.");
- throw ex;
+ throw ex.AsMigrationToolsException(MigrationToolsException.ExceptionSource.Configuration);
}
XmlElement sourceTree = _sourceCommonStructureService.GetNodesXml(new string[] { sourceNode.Uri }, true);
NodeInfo structureParent;
@@ -461,9 +461,7 @@ private void ProcessCommonStructure(string treeTypeSource, string localizedTreeT
catch (Exception ex)
{
Exception ex2 = new Exception(string.Format("Unable to load Common Structure for Target.This is usually due to TFS having a different installed langauge version than was expected.. Validate that '{0}' is the correct name in your version. This would be something like 'Fläche' or 'Aire'. If you open the area tree in Visual Studio, or web access, you should see the name your langauage uses for 'Area' or 'Iteration. Do not try to add a specific area or iteration path to this field. Check the defaults on https://nkdagility.com/learn/azure-devops-migration-tools/Reference/Endpoints/TfsTeamProjectEndpoint/ for an example fro English.", localizedTreeTypeName), ex);
- Log.LogError(ex2, "Unable to load Common Structure for Target.");
- Telemetry.TrackException(ex2, null);
- throw ex2;
+ throw ex2.AsMigrationToolsException(MigrationToolsException.ExceptionSource.Configuration);
}
_pathToKnownNodeMap[structureParent.Path] = structureParent;
@@ -737,7 +735,7 @@ public string FixAreaPathAndIterationPathForTargetQuery(string sourceWIQLQuery,
structureType = TfsNodeStructureType.Iteration;
break;
default:
- throw new InvalidOperationException($"Field type {fieldType} is not supported for query remapping.");
+ throw new InvalidOperationException($"Field type {fieldType} is not supported for query remapping.").AsMigrationToolsException(MigrationToolsException.ExceptionSource.Internal);
}
var remappedPath = GetNewNodeName(value, structureType);
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
index 3570828ce..c54bf121f 100644
--- a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
+++ b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingTool.cs
@@ -76,7 +76,9 @@ public void MapUserIdentityField(TfsProcessor processor, Field field)
var mapps = GetMappingFileData();
if (mapps != null && mapps.ContainsKey(field.Value.ToString()))
{
+ var original = field.Value;
field.Value = mapps[field.Value.ToString()];
+ Log.LogDebug($"TfsUserMappingTool::MapUserIdentityField::Map:[original|{original}][new|{field.Value}]");
}
}
@@ -86,7 +88,12 @@ public void MapUserIdentityField(TfsProcessor processor, Field field)
private Dictionary GetMappingFileData()
{
- if (_UserMappings == null && System.IO.File.Exists(Options.UserMappingFile))
+ if (!System.IO.File.Exists(Options.UserMappingFile))
+ {
+ Log.LogError("TfsUserMappingTool::GetMappingFileData:: The UserMappingFile '{UserMappingFile}' cant be found! Provide a valid file or disable TfsUserMappingTool!", Options.UserMappingFile);
+ _UserMappings = new Dictionary();
+ }
+ if (_UserMappings == null)
{
var fileData = System.IO.File.ReadAllText(Options.UserMappingFile);
try
@@ -101,14 +108,7 @@ private Dictionary GetMappingFileData()
}
}
- else
- {
- Log.LogError($"TfsUserMappingTool::GetMappingFileData::No User Mapping file Provided! Provide file or disable TfsUserMappingTool");
- _UserMappings = new Dictionary();
- }
-
return _UserMappings;
-
}
private List GetUsersListFromServer(IGroupSecurityService gss)
diff --git a/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs b/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs
index aa888ab22..d1747a61f 100644
--- a/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs
+++ b/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs
@@ -93,10 +93,10 @@ private ClassData CreateClassDataFromOptions(List allTy
{
mainOrDefaultSection.Bind(instanceOfOption);
var json = ConvertSectionWithPathToJson(configuration, mainOrDefaultSection, instanceOfOption);
- data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "defaults", SampleFor = data.OptionsClassFullName, Code = json.Trim() });
+ data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "defaults", Order = 2, SampleFor = data.OptionsClassFullName, Code = json.Trim() });
} else
{
- data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "defaults", SampleFor = data.OptionsClassFullName, Code = "There are no defaults! Check the sample for options!" });
+ data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "defaults", Order = 2, SampleFor = data.OptionsClassFullName, Code = "There are no defaults! Check the sample for options!" });
}
}
if (!string.IsNullOrEmpty(instanceOfOption.ConfigurationMetadata.PathToSample))
@@ -107,14 +107,14 @@ private ClassData CreateClassDataFromOptions(List allTy
if (sampleSection.Exists())
{
var json = ConvertSectionWithPathToJson(configuration, sampleSection, instanceOfOption);
- data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "sample", SampleFor = data.OptionsClassFullName, Code = json.Trim() });
+ data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "sample", Order = 1, SampleFor = data.OptionsClassFullName, Code = json.Trim() });
}
else
{
- data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "sample", SampleFor = data.OptionsClassFullName, Code = "There is no sample, but you can check the classic below for a general feel." });
+ data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "sample", Order = 1, SampleFor = data.OptionsClassFullName, Code = "There is no sample, but you can check the classic below for a general feel." });
}
}
- data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "classic", SampleFor = data.OptionsClassFullName, Code = saveData.SeraliseDataToJson(instanceOfOption).Trim() });
+ data.ConfigurationSamples.Add(new ConfigurationSample() { Name = "classic", Order = 3, SampleFor = data.OptionsClassFullName, Code = saveData.SeraliseDataToJson(instanceOfOption).Trim() });
if (instanceOfOption != null)
{
JObject joptions = (JObject)JToken.FromObject(instanceOfOption);
@@ -150,6 +150,14 @@ private List populateOptions(object item, JObject joptions)
static string ConvertSectionWithPathToJson(IConfiguration configuration, IConfigurationSection section, IOptions option = null)
{
var pathSegments = option == null ? section.Path.Split(':') : option.ConfigurationMetadata.PathToInstance.Split(':');
+
+ // If IsKeyed is true, we skip the lowest path segment
+ if (option != null && option.ConfigurationMetadata.IsKeyed && pathSegments.Length > 1)
+ {
+ pathSegments = pathSegments.Take(pathSegments.Length - 1).ToArray();
+ }
+
+
JObject root = new JObject();
JObject currentObject = root;
@@ -198,7 +206,15 @@ static string ConvertSectionWithPathToJson(IConfiguration configuration, IConfig
else
{
// Handle as a regular object
- currentObject[key] = sectionObject;
+ JObject itemObject = sectionObject as JObject ?? new JObject();
+
+ // Add ObjectName and OptionFor if IsKeyed is true
+ if (option != null && option.ConfigurationMetadata.IsKeyed)
+ {
+ itemObject.AddFirst(new JProperty(option.ConfigurationMetadata.ObjectName, option.ConfigurationMetadata.OptionFor));
+ }
+
+ currentObject[key] = itemObject;
}
}
}
diff --git a/src/MigrationTools.ConsoleDataGenerator/ReferenceData.cs b/src/MigrationTools.ConsoleDataGenerator/ReferenceData.cs
index 2fa516507..21233c86a 100644
--- a/src/MigrationTools.ConsoleDataGenerator/ReferenceData.cs
+++ b/src/MigrationTools.ConsoleDataGenerator/ReferenceData.cs
@@ -80,6 +80,8 @@ public class OptionsItem
public class ConfigurationSample
{
public string Name { get; set; }
+
+ public int Order { get; set; }
public string Description { get; set; }
public string Code { get; set; }
public string SampleFor { get; set; }
diff --git a/src/MigrationTools.Host/Commands/CommandBase.cs b/src/MigrationTools.Host/Commands/CommandBase.cs
index 13d8fc1e3..cf81c742e 100644
--- a/src/MigrationTools.Host/Commands/CommandBase.cs
+++ b/src/MigrationTools.Host/Commands/CommandBase.cs
@@ -105,6 +105,7 @@ public sealed override async Task ExecuteAsync(CommandContext context, TSet
Lifetime.StopApplication();
CommandActivity?.Stop();
_logger.LogInformation("Command {CommandName} completed in {Elapsed}", this.GetType().Name, CommandActivity?.Duration);
+ _logger.LogInformation("Check the logs for errors: {LogPath}", LogLocationService.GetLogPath());
}
}
@@ -196,6 +197,7 @@ private void ApplicationStartup(TSettings settings)
_logger.LogInformation("Running with settings: {@settings}", settings);
_logger.LogInformation("OSVersion: {OSVersion}", Environment.OSVersion.ToString());
_logger.LogInformation("Version (Assembly): {Version}", _MigrationToolVersion.GetRunningVersion().versionString);
+ _logger.LogInformation("Logpath: {LogPath}", LogLocationService.GetLogPath());
}
diff --git a/src/MigrationTools.Host/MigrationToolHost.cs b/src/MigrationTools.Host/MigrationToolHost.cs
index e0c47fc83..4570090ce 100644
--- a/src/MigrationTools.Host/MigrationToolHost.cs
+++ b/src/MigrationTools.Host/MigrationToolHost.cs
@@ -53,7 +53,7 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action lc
.Filter.ByExcluding(Matching.FromSource("Microsoft.Hosting.Lifetime"))
.Filter.ByExcluding(Matching.FromSource("Microsoft.Extensions.Hosting.Internal.Host"))
@@ -141,20 +141,5 @@ public static IHostBuilder CreateDefaultBuilder(string[] args, Action EndpointEnrichers { get; set; }
+
[JsonIgnore]
public bool Enabled { get; set; }
diff --git a/src/MigrationTools/Exceptions/MigrationToolsException.cs b/src/MigrationTools/Exceptions/MigrationToolsException.cs
new file mode 100644
index 000000000..c3c6580c8
--- /dev/null
+++ b/src/MigrationTools/Exceptions/MigrationToolsException.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Elmah.Io.Client;
+using static MigrationTools.Exceptions.MigrationToolsException;
+
+namespace MigrationTools.Exceptions
+{
+
+ public static class MigrationToolsExceptionExtensions
+ {
+ public static MigrationToolsException AsMigrationToolsException(this Exception ex, ExceptionSource errorSource)
+ {
+ return new MigrationToolsException(ex, errorSource);
+ }
+ }
+
+ public class MigrationToolsException : Exception
+ {
+ public MigrationToolsException(Exception ex, ExceptionSource errorSource) : base(ex.Message)
+ {
+ this.ErrorSource = errorSource;
+ }
+
+ public ExceptionSource ErrorSource { get; }
+
+ public enum ExceptionSource
+ {
+ Configuration,
+ Internal
+ }
+ }
+}
diff --git a/src/MigrationTools/Processors/Infrastructure/Processor.cs b/src/MigrationTools/Processors/Infrastructure/Processor.cs
index 14bafe1e6..5ac015ae8 100644
--- a/src/MigrationTools/Processors/Infrastructure/Processor.cs
+++ b/src/MigrationTools/Processors/Infrastructure/Processor.cs
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
+using System.ComponentModel.Design;
using System.Diagnostics;
using System.Linq;
using Microsoft.Extensions.DependencyInjection;
@@ -64,13 +65,13 @@ public IEndpoint GetEndpoint(string name)
{
throw new ArgumentException("Endpoint name cannot be null or empty", nameof(name));
}
- // Assuming GetRequiredKeyedService throws an exception if the service is not found
- IEndpoint endpoint = Services.GetKeyedService(name);
- if (endpoint == null)
- {
- throw new ConfigurationValidationException( Options, ValidateOptionsResult.Fail($"The Endpoint '{name}' specified for `{this.GetType().Name}` was not found."));
- }
- return endpoint;
+ // Assuming GetRequiredKeyedService throws an exception if the service is not found
+ IEndpoint endpoint = Services.GetKeyedService(name);
+ if (endpoint == null)
+ {
+ throw new ConfigurationValidationException(Options, ValidateOptionsResult.Fail($"The Endpoint '{name}' specified for `{this.GetType().Name}` was not found."));
+ }
+ return endpoint;
}
public void Execute()
@@ -113,12 +114,28 @@ public void Execute()
ProcessorActivity.SetStatus(ActivityStatusCode.Error);
Log.LogCritical(ex, "Validation of your configuration failed:");
}
+ catch (MigrationToolsException ex)
+ {
+ Status = ProcessingStatus.Failed;
+ ProcessorActivity.SetStatus(ActivityStatusCode.Error);
+ switch (ex.ErrorSource)
+ {
+ case MigrationToolsException.ExceptionSource.Configuration:
+ Log.LogCritical(ex, "An error occurred in the Migration Tools causing it to stop! This is likley due to a configuration issue and is not being logged remotely. You can always ask on https://github.com/nkdAgility/azure-devops-migration-tools/discussions ");
+ break;
+ case MigrationToolsException.ExceptionSource.Internal:
+ default:
+ Log.LogCritical(ex, "An error occurred in the Migration Tools causing it to stop!");
+ Telemetry.TrackException(ex, ProcessorActivity.Tags);
+ break;
+ }
+ }
catch (Exception ex)
{
Status = ProcessingStatus.Failed;
ProcessorActivity.SetStatus(ActivityStatusCode.Error);
- Telemetry.TrackException(ex, ProcessorActivity.Tags);
Log.LogCritical(ex, "Error while running {MigrationContextname}", Name);
+ Telemetry.TrackException(ex, ProcessorActivity.Tags);
}
finally
{
diff --git a/src/MigrationTools/Processors/Infrastructure/ProcessorOptions.cs b/src/MigrationTools/Processors/Infrastructure/ProcessorOptions.cs
index 92ed9a478..e516e2d80 100644
--- a/src/MigrationTools/Processors/Infrastructure/ProcessorOptions.cs
+++ b/src/MigrationTools/Processors/Infrastructure/ProcessorOptions.cs
@@ -34,14 +34,18 @@ public abstract class ProcessorOptions : IProcessorOptions, IValidateOptions
/// List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.
///
+ [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public List Enrichers { get; set; }
+ [Required]
public string SourceName { get; set; }
+ [Required]
public string TargetName { get; set; }
///
/// `Refname` will be used in the future to allow for using named Options without the need to copy all of the options.
///
+ [JsonIgnore]
public string RefName { get; set; }
public IProcessorOptions GetSample()
diff --git a/src/MigrationTools/Services/LogLocationService.cs b/src/MigrationTools/Services/LogLocationService.cs
new file mode 100644
index 000000000..c0f123ccb
--- /dev/null
+++ b/src/MigrationTools/Services/LogLocationService.cs
@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Reflection;
+using System.Text;
+
+namespace MigrationTools.Services
+{
+ public class LogLocationService
+ {
+ private static string logDate = DateTime.Now.ToString("yyyyMMddHHmmss");
+
+
+ private static string _logsPath = CreateLogsPath();
+
+ public static string GetLogPath()
+ {
+ // Check if the string has been generated.
+ if (_logsPath == null)
+ {
+ // Generate the string at runtime (e.g., any custom logic).
+ _logsPath = CreateLogsPath();
+ }
+
+ // Return the _logsPath string.
+ return _logsPath;
+ }
+
+ private static string CreateLogsPath()
+ {
+ string exportPath;
+ string assPath = Assembly.GetEntryAssembly().Location;
+ exportPath = Path.Combine(Path.GetDirectoryName(assPath), "logs", logDate);
+ if (!Directory.Exists(exportPath))
+ {
+ Directory.CreateDirectory(exportPath);
+ }
+
+ return exportPath;
+ }
+ }
+}
diff --git a/src/MigrationTools/Tools/StringManipulatorTool.cs b/src/MigrationTools/Tools/StringManipulatorTool.cs
index 2cb9d5fb6..95e393688 100644
--- a/src/MigrationTools/Tools/StringManipulatorTool.cs
+++ b/src/MigrationTools/Tools/StringManipulatorTool.cs
@@ -34,9 +34,11 @@ public void ProcessorExecutionWithFieldItem(IProcessor processor, FieldItem fiel
}
if (fieldItem.FieldType == "String" && fieldItem.Value != null)
{
- if (HasManipulators())
+ if (!HasManipulators())
{
- foreach (var manipulator in Options.Manipulators)
+ AddDefaultManipulator();
+ }
+ foreach (var manipulator in Options.Manipulators)
{
if (manipulator.Enabled)
{
@@ -49,7 +51,7 @@ public void ProcessorExecutionWithFieldItem(IProcessor processor, FieldItem fiel
Log.LogDebug("{WorkItemProcessorEnricher}::ProcessorExecutionWithFieldItem::Disabled::{Description}", GetType().Name, manipulator.Description);
}
}
- }
+
if (HasStringTooLong(fieldItem))
{
fieldItem.Value = fieldItem.Value.ToString().Substring(0, Math.Min(fieldItem.Value.ToString().Length, Options.MaxStringLength));
@@ -58,6 +60,15 @@ public void ProcessorExecutionWithFieldItem(IProcessor processor, FieldItem fiel
}
+ private void AddDefaultManipulator()
+ {
+ if (Options.Manipulators == null)
+ {
+ Options.Manipulators = new List();
+ }
+ Options.Manipulators.Add(new RegexStringManipulator() { Enabled = true, Description = "Default: Removes invalid chars!", Pattern = "[^( -~)\n\r\t]+", Replacement = "" });
+ }
+
private bool HasStringTooLong(FieldItem fieldItem)
{
return fieldItem.Value.ToString().Length > 0 && fieldItem.Value.ToString().Length > Options.MaxStringLength;