Skip to content

Commit

Permalink
Documentation Update (v16) part 2 (#2329)
Browse files Browse the repository at this point in the history
Update metrics, and documentation samples...
  • Loading branch information
MrHinsh authored Sep 5, 2024
2 parents 2890b75 + 3023335 commit 4ff593c
Show file tree
Hide file tree
Showing 33 changed files with 1,338 additions and 919 deletions.
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ For the most part we support moving data between ((Azure DevOps Server | Team Fo
- [Configuration Reference](https://nkdagility.com/learn/azure-devops-migration-tools/Reference/)
- [Community Support](https://github.com/nkdAgility/azure-devops-migration-tools/discussions)
- [Commercial Support](https://nkdagility.com/capabilities/azure-devops-migration-services/)
- [Change Log](https://nkdagility.com/learn/azure-devops-migration-tools/change-log/)

The documentation for the preview is on [Preview](https://nkdagility.com/docs/azure-devops-migration-tools/preview/)]

Expand All @@ -88,9 +89,7 @@ The documentation for the preview is on [Preview](https://nkdagility.com/docs/az
| Migration Run Total | **19bn Seconds** | Thats **316m hours** or **13m days** of run time in the last 30 days. |
| Average Work item Migration Time | **22s** | Work Item (includes all revisions, links, and attachments for the work item) |

Exceptions shipped to Application Insights and [Elmah.io](https://elmah.io) for analysis and improvement.


This tool uses OpenTelemetery to collect metrics and logs, and Application Insights to store and analyse them. Exceptions are also sent to [Elmah.io](https://elmah.io) for analysis and improvement.

## Advanced tools

Expand All @@ -117,22 +116,3 @@ We use these tools with our customers, and for fun, to do real world migrations
- Consult with your internal folks who need help and guidance in running the tooling.
- Make changes to the tool to support your needs; all additions are committed to the main repo.
- Run the migration for you:- you would need to pay for the hours that we would spend baby-sitting the running migrations

## Change Log

- [v16.0.0](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v16.0.0) - Enhanced configuration with support for command line, and environmental variable overrides.
- [v15.1.7](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v15.1.7) - The latest release brings a host of enhancements and fixes designed to improve user experience and configuration options. Noteworthy features include a new GitHub Actions workflow for automatic updates to pull request titles, enhanced management of area and iteration paths using regex mapping, and a more streamlined query format for migration configurations. Users can now enjoy greater flexibility in configuring attachment processing, including options for export paths and size limits. Additionally, updates to authentication methods and improved logging for user retrieval processes have been implemented. The release also addresses various bugs and makes adjustments to enhance overall functionality.
- [v14.4.7](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v14.4.7) - The latest major release brings a host of user-focused enhancements and improvements. Key changes include the adoption of Winget as the primary installation method, making it easier for users to get started. The main executable has been renamed to `devopsmigration.exe`, and new configuration options enhance customization capabilities, including parallel builds and test case timeouts. The command for initializing configurations has been updated for greater flexibility, and logging improvements provide better insights during migration operations. Subsequent updates have refined version detection, improved command line arguments, and introduced new configuration files to prevent blank issues. Enhanced logging and error handling further improve user experience, while package upgrades and better handling of specific fields streamline migration processes. Overall, these updates aim to enhance functionality, usability, and reliability for users.
- [v13.2.1](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v13.2.1) - The latest updates bring a range of enhancements and new features aimed at improving user experience and functionality. A key addition is the `WorkItemMigrationContext` processor, which facilitates the migration of work items, including their history and attachments, between Azure DevOps instances. Users will find clearer documentation and a new configuration file to simplify work item type and field mappings. The introduction of the `ExportUsersForMapping` feature allows for easy JSON file exports for field mapping, while security is bolstered with an updated authentication mode. Users can now disable telemetry collection during migration, and various improvements have been made to migration behavior and configuration settings, enhancing the overall robustness and integrity of the migration tools.
- [v12.8.10](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v12.8.10) - The latest major release brings a host of enhancements designed to improve user experience and streamline migration processes. New configuration options for migration processors offer greater flexibility, allowing users to define custom remapping rules for area and iteration paths. Significant improvements in field mapping configurations and enhanced documentation provide clearer guidance for users. The introduction of features like case-insensitive matching for regular expressions and new parameters for work item migration enhances functionality. Additionally, updates to logging, error handling, and overall documentation structure ensure a more robust and user-friendly experience. Various bug fixes further contribute to the reliability and clarity of the migration tools, making the overall process smoother for users.
- [v11.9.55](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v11.9.55) - The latest major release introduces a variety of impactful changes designed to enhance user experience and streamline migration processes. Key features include a rebranding of the project to "MigrationTools," improved configuration options, and enhanced error handling for migration operations. Users can now limit revisions during work item migrations, customize field retrieval, and benefit from new logging capabilities for better traceability. The introduction of new interfaces and methods, along with refined documentation, supports improved work item management and configuration flexibility. Overall, these updates aim to provide a more efficient, user-friendly migration experience while addressing previous bugs and enhancing system performance.
- [v10.2.13](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v10.2.13) - The latest updates to the Migration Tools suite introduce a range of impactful enhancements for users. New projects, such as "MigrationTools.Sinks.AzureDevOps," have been added, along with a revamped console UI for improved Azure DevOps integration. Configuration management has been enhanced, allowing for easier JSON file loading and new telemetry settings. The migration engine has been optimized for better work item handling, and logging has been clarified. Users will need to update their configuration files due to a namespace change and new parameters for work item migration. Subsequent updates further simplify the configuration process, improve field mapping options, and enhance documentation for migrating test artifacts. Overall, these changes provide users with greater flexibility, control, and usability in their migration tasks.
- [v9.3.1](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v9.3.1) - The latest major release brings a host of user-focused enhancements and improvements. Key features include multi-language support for Azure DevOps migrations, allowing for greater flexibility in handling different language versions. Users will benefit from improved configuration documentation, which now includes new fields for language mapping of Area and Iteration paths. Subsequent updates have introduced customizable field mappings, conditional logic for excluding specific work item types, and enhanced error handling for better troubleshooting. Additionally, logging capabilities have been significantly upgraded, providing more structured output and insights into application performance. Overall, these changes aim to streamline the migration process and improve user experience.
- [v8.9.10](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v8.9.10) - The latest major release introduces a range of impactful enhancements and features designed to improve user experience and streamline migration processes. Users can now take advantage of enhanced configuration options, including custom paths for configuration files and new modes for the `init` command. The migration process has been significantly refined with improved error handling, better logging, and new parameters for managing attachments and links. Notable features include the ability to sync changes post-migration, retry failed work item saves, and customize attachment handling. Additionally, the rebranding of the tool ensures users have access to accurate documentation and resources. Overall, these updates focus on providing greater control, efficiency, and clarity throughout the migration experience.
- [7.5.74](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/7.5.74) - The latest major release brings a host of user-focused enhancements and features designed to improve performance and usability. Key updates include a framework upgrade that boosts application performance and compatibility, alongside dependency updates for improved functionality and security. New configuration options allow for greater flexibility during data migration, including filtering elements by tags and replaying work item revisions. Enhancements to error handling and logging, as well as improvements in attachment management, contribute to a more reliable user experience. Additionally, the introduction of online status checks for version updates ensures users stay informed about the latest changes while connected to the internet.
- [6.3.1](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/6.3.1) - The latest major release brings a host of impactful changes for users. A key highlight is the rebranding of the command-line tool to `vstssyncmigrator`, accompanied by updated documentation to assist with the new command structure. Enhancements to attachment export and import migration contexts improve ID formatting, while the restructuring of project organization may necessitate updates to project references. Users will also benefit from improved global configuration documentation, with various processors now enabled by default for immediate functionality. New features include the `WorkItemQueryMigrationContext`, allowing for selective migration of work item queries, and the option to prefix project names in folder paths for better organization. Enhanced logging and an updated FAQ section further support users in managing their migration processes effectively.
- [5.3.2](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/5.3.2) - The latest major release brings a host of impactful changes designed to enhance user experience and functionality. Key updates include a rebranding to "VSTS Sync Migration Tools" and a simplified command name for installation and uninstallation. Users can now benefit from the new `MultiValueConditionalMapConfig` class, which allows for more complex field mapping configurations. Version 5.1 introduces customizable user preferences and improved command-line functionality, while 5.3 enhances the migration process for test plans with a new method for handling test cases, updates to installation scripts for better package verification, and optimizations in field merging. Comprehensive new documentation supports these changes, ensuring users can easily adapt to the updated features and configurations.
- [4.4.0](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/4.4.0) - The latest major release introduces a range of impactful enhancements aimed at improving user experience and flexibility during work item migration. A key feature is the new configuration option, `PrefixProjectToNodes`, which allows users to customize the prefixing of project names to area and iteration paths, as well as nodes, enhancing project structure management. The migration logic has been updated to support these options, streamlining the migration process. Additionally, users will benefit from improved documentation, including clearer installation instructions and new JSON configuration files. The release also includes an uninstall script for easier tool management and enhancements to caching and field exclusion during migrations, further refining the overall functionality.
- [3.6.0.1](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/3.6.0.1) - The latest updates bring a host of enhancements designed to improve user experience and functionality. Key features include new configuration files for the VSTS Data Bulk Editor, allowing for tailored migration processes, and the introduction of classes for managing team settings. Users can now specify additional query criteria for attachment exports and customize employee picture URL formats. The migration process has been streamlined with improved telemetry tracking and error handling, while new documentation provides valuable context and guidance. Significant improvements to the TfsWitMigrator tool enhance work item tagging flexibility, and updates to the migration context for test plans and variables offer greater control during migrations. Overall, these changes aim to make data migration more efficient and user-friendly.
- [0.5.1](https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/0.5.1) - The latest update brings a range of enhancements designed to improve user experience. Users will benefit from increased performance and stability, alongside new features that simplify interactions. Additionally, numerous bugs identified in earlier releases have been resolved, contributing to a more seamless and dependable operation. This update focuses on creating a more efficient and user-friendly environment for all.

15 changes: 15 additions & 0 deletions appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,17 @@
},
"Infrastructure": {
"ClassNameChangeMappings": {
"TfsGitRepositoryTool": "TfsGitRepositoryTool",
"TfsTeamSettingsEnricher": "TfsTeamSettingsTool",
"TfsWorkItemLinkEnricher": "TfsWorkItemLinkTool",
"TfsAttachmentEnricher": "TfsAttachmentTool",
"StringManipulatorEnricher": "StringManipulatorTool",
"TfsUserMappingEnricher": "TfsUserMappingTool",
"FieldBlankMap": "FieldClearMap",
"FieldtoTagMap": "FieldToTagFieldMap",
"TreeToTagMap": "TreeToTagFieldMap",
"TeamMigration": "TfsTeamSettingsProcessor",
"WorkItemQueryMigration": "TfsSharedQueryProcessor",
"WorkItemMigration": "TfsWorkItemMigrationProcessor",
"WorkItemMigrationContext": "TfsWorkItemMigrationProcessor",
"TfsTeamProjectConfig": "TfsTeamProjectEndpoint",
Expand All @@ -485,17 +496,21 @@
"ExportTeamListProcessor": "TfsExportTeamListProcessor",
"ExportTeamList": "TfsExportTeamListProcessor",
"ExportUsersForMappingProcessor": "TfsExportUsersForMappingProcessor",
"TestConfigurationsMigration": "TfsTestConfigurationsMigrationProcessor",
"TestConfigurationsMigrationProcessor": "TfsTestConfigurationsMigrationProcessor",
"TestConfigurationsMigrationContext": "TfsTestConfigurationsMigrationProcessor",
"TestPlansAndSuitesMigration": "TfsTestPlansAndSuitesMigrationProcessor",
"TestPlansAndSuitesMigrationProcessor": "TfsTestPlansAndSuitesMigrationProcessor",
"TestPlansAndSuitesMigrationContext": "TfsTestPlansAndSuitesMigrationProcessor",
"TestVariablesMigration": "TfsTestVariablesMigrationProcessor",
"TestVariablesMigrationProcessor": "TfsTestVariablesMigrationProcessor",
"TestVariablesMigrationContext": "TfsTestVariablesMigrationProcessor",
"WorkItemBulkEditProcessor": "TfsWorkItemBulkEditProcessor",
"WorkItemUpdate": "TfsWorkItemBulkEditProcessor",
"WorkItemDelete": "TfsWorkItemDeleteProcessor",
"WorkItemDeleteProcessor": "TfsWorkItemDeleteProcessor",
"WorkItemPostProcessingContext": "TfsWorkItemOverwriteProcessor",
"WorkItemPostProcessing": "TfsWorkItemOverwriteProcessor",
"WorkItemPostProcessingProcessor": "TfsWorkItemOverwriteProcessor",
"WorkItemUpdateAreasAsTagsContext": "TfsWorkItemOverwriteProcessor",
"WorkItemUpdateAreasAsTagsProcessor": "TfsWorkItemOverwriteProcessor"
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4ff593c

Please sign in to comment.