diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 7b856912a..9163b3fdb 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,5 +1,3 @@ # These are supported funding model platforms github: nkdAgility -patreon: nakedagility -custom: ['https://monzo.me/martinhinshelwood'] diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e734c2d30..06ac3b84d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,3 +9,7 @@ updates: directory: "/src" # Location of package manifests schedule: interval: "weekly" + - package-ecosystem: "github-actions" + directory: "/" # Location of package manifests + schedule: + interval: "weekly" \ No newline at end of file diff --git a/.github/workflows/MigrationToolsTelemetery.yml b/.github/workflows/MigrationToolsTelemetery.yml index 93710f782..415b1e22a 100644 --- a/.github/workflows/MigrationToolsTelemetery.yml +++ b/.github/workflows/MigrationToolsTelemetery.yml @@ -18,11 +18,11 @@ jobs: steps: - uses: actions/checkout@v4 - name: Setup .NET SDK - uses: actions/setup-dotnet@v3 + uses: actions/setup-dotnet@latest with: dotnet-version: ${{ env.DOTNET_CORE_VERSION }} - name: Setup .NET Core (for inproc extensions) - uses: actions/setup-dotnet@v1 + uses: actions/setup-dotnet@latest with: dotnet-version: ${{ env.DOTNET_CORE_VERSION_INPROC }} - name: Restore diff --git a/.github/workflows/close-pr.yaml b/.github/workflows/close-pr.yaml new file mode 100644 index 000000000..09926c0af --- /dev/null +++ b/.github/workflows/close-pr.yaml @@ -0,0 +1,24 @@ +name: Azure Static Web App PR Cleanup + +on: + pull_request: + types: [closed] + +jobs: + pr_cleanup: + runs-on: ubuntu-latest + steps: + - uses: actions/create-github-app-token@v1 + id: app-token + with: + app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} + private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} + - name: Clean up pull request environment + uses: Azure/static-web-apps-deploy@v1 + with: + azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }} + action: 'close' + app_location: '' + skip_app_build: true + skip_api_build: true + repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index 53434fcdf..a2fbd4965 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -1,22 +1,22 @@ -name: "Pull Request Labeler" -on: -- pull_request_target +# name: "Pull Request Labeler" +# on: +# - pull_request_target -jobs: - labeler: - permissions: - contents: read - pull-requests: write - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - uses: actions/create-github-app-token@v1 - id: app-token - with: - app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} - private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} - - uses: actions/labeler@v5 - with: - sync-labels: true - repo-token: ${{ steps.app-token.outputs.token }} \ No newline at end of file +# jobs: +# labeler: +# permissions: +# contents: read +# pull-requests: write +# runs-on: ubuntu-latest +# steps: +# - name: Checkout +# uses: actions/checkout@v4 +# - uses: actions/create-github-app-token@v1 +# id: app-token +# with: +# app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} +# private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} +# - uses: actions/labeler@v5 +# with: +# sync-labels: true +# repo-token: ${{ steps.app-token.outputs.token }} \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 214161e47..4463bfaa6 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -8,7 +8,8 @@ on: push: branches: ["main"] tags-ignore: ["v*-*"] - pull_request: + pull_request_target: + types: [opened, synchronize, labeled] branches: ["main"] workflow_dispatch: inputs: @@ -31,6 +32,11 @@ jobs: # Setup & Configuration Setup: name: "Setup & Configuration " + if: ${{ (github.event_name == 'push') || + (github.event_name == 'workflow_dispatch') || + (github.event_name == 'pull_request_target' && + (github.event.pull_request.head.repo.full_name == github.repository || contains(github.event.pull_request.labels.*.name, 'safe-to-build'))) + }} runs-on: ubuntu-latest outputs: GitVersion_BranchName: ${{ steps.gitversion.outputs.GitVersion_BranchName }} @@ -52,11 +58,24 @@ jobs: nkdAgility_DocsBaseURL: ${{ steps.nkdagility.outputs.docs_baseURL }} nkdAgility_DocsVersionFolder: ${{ steps.nkdagility.outputs.docs_version_folder }} nkdAgility_RunRelease: ${{ steps.nkdagility.outputs.RunRelease }} - + nkdAgility_AzureSitesEnvironment: ${{ steps.nkdagility.outputs.AzureSitesEnvironment }} steps: + - uses: actions/create-github-app-token@v1 + id: app-token + with: + app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} + private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} + - name: Remove "safe" label from PR + if: ${{ github.event.pull_request.head.repo.full_name != github.repository }} + uses: actions-ecosystem/action-remove-labels@v1 + with: + token: ${{ steps.app-token.outputs.token }} + labels: safe-to-build - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: + repository: ${{ github.event_name == 'push' && github.repository || github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event_name == 'push' && github.ref || github.event.pull_request.head.ref }} fetch-depth: 0 - name: Install GitVersion uses: gittools/actions/gitversion/setup@v1.1.1 @@ -68,11 +87,7 @@ jobs: uses: gittools/actions/gitversion/execute@v1.1.1 with: useConfigFile: true - - uses: actions/create-github-app-token@v1 - id: app-token - with: - app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} - private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} + - uses: dorny/paths-filter@v3 id: filter with: @@ -84,6 +99,7 @@ jobs: automation: - 'build/**' - '.github/workflows/**' + - name: "Build NKDAgility Outputs" shell: pwsh id: nkdagility @@ -116,6 +132,7 @@ jobs: $WingetApplicationId = "nkdagility.azure-devops-migration-tools"; $docs_deploy_folder = "./azure-devops-migration-tools/" $docs_baseURL = "/learn/azure-devops-migration-tools" + $AzureSitesEnvironment = "" $RunRelease = 'true' } "Preview" { @@ -123,6 +140,7 @@ jobs: $WingetApplicationId = "nkdagility.azure-devops-migration-tools.Preview"; $docs_deploy_folder = "./azure-devops-migration-tools/preview/"; $docs_baseURL = "/learn/azure-devops-migration-tools/preview" + $AzureSitesEnvironment = "preview"; $RunRelease = ( ('${{ inputs.ForceRelease }}' -eq 'true' ) -or ('${{ steps.filter.outputs.src }}' -eq 'true') -or ('${{ steps.filter.outputs.docs }}' -eq 'true') ) } default { @@ -130,6 +148,7 @@ jobs: $WingetApplicationId = "nkdagility.azure-devops-migration-tools.Canary"; $docs_deploy_folder = "./azure-devops-migration-tools/canary/$branchSafeName" $docs_baseURL = "/learn/azure-devops-migration-tools/canary/$branchSafeName" + $AzureSitesEnvironment = "$branchSafeName" $RunRelease = 'false' } } @@ -141,6 +160,8 @@ jobs: echo "docs_deploy_folder=$docs_deploy_folder" >> $env:GITHUB_OUTPUT Write-Output "docs_baseURL=$docs_baseURL" echo "docs_baseURL=$docs_baseURL" >> $env:GITHUB_OUTPUT + Write-Output "We are running for the $AzureSitesEnvironment AzureSitesEnvironment!" + echo "AzureSitesEnvironment=$AzureSitesEnvironment" >> $env:GITHUB_OUTPUT Write-Output "RunRelease=$RunRelease" echo "RunRelease=$RunRelease" >> $env:GITHUB_OUTPUT Write-Output "-------------------------------------------" @@ -201,6 +222,7 @@ jobs: - nkdAgility_DocsVersionFolder: ${{needs.Setup.outputs.nkdAgility_DocsVersionFolder}} - nkdAgility_DocsDeployFolder: ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} - nkdAgility_DocsBaseURL: ${{needs.Setup.outputs.nkdAgility_DocsBaseURL}} + - nkdAgility_AzureSitesEnvironment: ${{needs.Setup.outputs.nkdAgility_AzureSitesEnvironment}} - nkdAgility_ReleaseDescriptionState: ${{needs.Setup.outputs.nkdAgility_ReleaseDescriptionState}} - nkdAgility_RunRelease: ${{needs.Setup.outputs.nkdAgility_RunRelease}} ### GitVersion @@ -249,19 +271,22 @@ jobs: GitVersion_MajorMinorPatch: ${{ needs.Setup.outputs.GitVersion_MajorMinorPatch }} steps: - name: Set up JDK 17 - uses: actions/setup-java@v3 + uses: actions/setup-java@v2 with: java-version: 17 distribution: 'zulu' - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 + with: + repository: ${{ github.event_name == 'push' && github.repository || github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event_name == 'push' && github.ref || github.event.pull_request.head.ref }} - uses: cschleiden/replace-tokens@v1 with: files: '["**/StaticVariables.cs"]' tokenPrefix: "${" tokenSuffix: "}" - name: Setup .NET - uses: actions/setup-dotnet@v1 + uses: actions/setup-dotnet@v4 with: dotnet-version: | 8.x @@ -334,7 +359,10 @@ jobs: GitVersion_AssemblySemVer: ${{ needs.Setup.outputs.GitVersion_AssemblySemVer }} GitVersion_InformationalVersion: ${{ needs.Setup.outputs.GitVersion_InformationalVersion }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 + with: + repository: ${{ github.event_name == 'push' && github.repository || github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event_name == 'push' && github.ref || github.event.pull_request.head.ref }} - name: Setup Ruby uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0 with: @@ -365,6 +393,17 @@ jobs: with: name: AzureDevOpsMigrationTools-Site path: ./_site/**/* + - name: Build with Jekyll 2 + # Outputs to the './_site' directory by default + run: bundle exec jekyll build --destination ./_site2/ --baseurl "" + env: + JEKYLL_ENV: production + # - name: Build Jekyll + # uses: jerryjvl/jekyll-build-action@v1 + - uses: actions/upload-artifact@v4 + with: + name: AzureDevOpsMigrationTools-Site2 + path: ./_site2/**/* # GitHubRelease @@ -458,7 +497,7 @@ jobs: if: ${{ success() && ( needs.Setup.outputs.nkdAgility_Ring == 'Release' ) }} steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 - uses: actions/download-artifact@v4 - name: "Find files" shell: pwsh @@ -511,7 +550,7 @@ jobs: if: ${{ success() && ( needs.Setup.outputs.nkdAgility_RunRelease == 'true' ) }} steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 - uses: actions/download-artifact@v4 - name: "Find files" shell: pwsh @@ -541,7 +580,7 @@ jobs: run: | Get-Item -Path .\ - name: SFTP Upload ${{ (needs.Setup.outputs.nkdAgility_Ring) }} - uses: Dylan700/sftp-upload-action@v1.1.4 + uses: Dylan700/sftp-upload-action@latest with: server: nakedalmweb.sftp.wpengine.com username: nakedalmweb-learn @@ -553,4 +592,39 @@ jobs: uploads: | ./_site/ => ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} # If true, any existing files in the remote upload directories are deleted. - delete: false \ No newline at end of file + delete: false + + - uses: actions/create-github-app-token@v1 + id: app-token + with: + app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} + private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} + + - name: Download a single artifact + uses: actions/download-artifact@v4 + with: + name: AzureDevOpsMigrationTools-Site2 + path: ./_site2 + - name: Build and Deploy + uses: Azure/static-web-apps-deploy@v1 + id: azureDeploy + with: + repo_token: ${{ steps.app-token.outputs.token }} + action: 'upload' + app_location: ./_site2 + skip_app_build: true + skip_api_build: true + output_location: '' + deployment_environment: ${{ (needs.Setup.outputs.nkdAgility_AzureSitesEnvironment) }} + azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }} + + - name: 'Show Summery' + if: always() + shell: pwsh + id: nkdagility-summery + run: | + $markdown = @" + ## ${{needs.Setup.outputs.GitVersion_SemVer}} (${{needs.Setup.outputs.nkdAgility_Ring}}) + Docs deployed to [${{steps.azureDeploy.outputs.static_web_app_url}}](${{steps.azureDeploy.outputs.static_web_app_url}}) + "@ + echo $markdown >> $Env:GITHUB_STEP_SUMMARY diff --git a/.github/workflows/open-pr-describer.yml b/.github/workflows/open-pr-describer.yml index 48c2fbc27..3d07578cf 100644 --- a/.github/workflows/open-pr-describer.yml +++ b/.github/workflows/open-pr-describer.yml @@ -14,7 +14,7 @@ jobs: pull-request: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: Ant0wan/openai-pr@v1 with: api-key: ${{ secrets.OPENAI_API_KEY }} diff --git a/.github/workflows/opencommit.yml b/.github/workflows/opencommit.yml index b16dd7535..966288699 100644 --- a/.github/workflows/opencommit.yml +++ b/.github/workflows/opencommit.yml @@ -22,7 +22,7 @@ jobs: uses: actions/setup-node@v2 with: node-version: '16' - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - uses: di-sukharev/opencommit@github-action-v1.0.4 diff --git a/LICENSE b/LICENSE index c990bea19..0ad25db4b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,661 @@ -MIT License - -Copyright (c) 2017 naked Agility Ltd. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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;