Migrating from SpecSync v3 to v5
PreviousHow to handle Test Cases of multiple parallel application releasesNextMigrating from SpecSync v2 to v3
Last updated
Was this helpful?
Last updated
Was this helpful?
The licensing model of SpecSync allows you to use any versions, so it is recommended to always upgrade to the latest version.
SpecSync for Azure DevOps v5 has introduced a couple of useful improvements but the features and the configuration is highly backwards compatible with the v3 releases, therefore the migration process is usually simple.
You can find a complete list of improvements in the .
To perform the version upgrade, please follow the steps below.
Check the minimum . There are a few older Azure DevOps server versions that are not supported by v5. In case you need to synchronize scenarios with any of these you cannot upgrade to v5. As these sever version are not supported by Microsoft anymore, we recommend upgrading to a newer version.
Server versions not supported by v5 anymore:
Team Foundation Server 2017 (Microsoft support ended: )
Team Foundation Server 2018 (Microsoft support ended: )
Azure DevOps Server 2019 (Microsoft support ended: )
Some older .NET versions are not supported anymore. Please note that the .NET version requirement is only about the .NET SDK installed in order to run SpecSync. The synchronize project can still target old .NET versions as well.
If you cannot install a compatible .NET version to your systems where SpecSync is executed, we recommend using the SpecSync or execute SpecSync from .
.NET versions not supported by v5 anymore:
.NET 3.1
.NET 5
Besides the server versions or .NET frameworks that are not supported anymore, there are also a few minor breaking changes as well.
These are partially related to removing features that have been marked deprecated earlier. The features that have been deprecated always provide a warning, so if your SpecSync v3.4 commands currently execute without warnings, these will not impact your usage.
One of the new features of SpecSync v5 is the upgrade command. This command can be used to invoke the upgrade wizard that automatically fixes changes in the configuration file (e.g. for renamed configuration settings) and also prompts for configuring additional new features or configuration options.
The upgrade command only modifies the configuration file but it does not change anything in the Azure DevOps server. So you can perform the upgrade command safely and review the changes in the configuration file manually before performing a synchronization.
Once the upgrade command has been executed, you can review the changes of the configuration file.
If the changes look good, you can perform a synchronization with the push command. It is recommended first to review the synchronization steps without actually changing the Azure DevOps server using the --dryRun option.
If the result is good, you can do the final synchronization with the push command.
SpecSync v5 has improved integration with Azure DevOps pipelines. The most important change is that the task will not fail automatically on warnings, but will register the warning to the pipeline result instead. Therefore the option --zeroExitCodeForWarnings is not needed anymore.
If you want to fail the pipelines for warnings, use the --treatWarningsAsErrors option.
The remaining breaking changes do not impact the most of usages, but please review the complete list of
Upgrade SpecSync to the latest v5 version. Please check the guide for detailed steps.