SpecSync Documentation
Jira
Jira
  • Introduction to SpecSync for Jira
  • Getting started
    • Getting started using SpecFlow
    • Getting started using Cucumber or other Gherkin-based BDD tool
  • Installation & Setup
    • Install as .NET tool
    • Install as .NET Console App
    • Install as native binaries for Linux or macOS
    • Install as Docker image
    • Setup and Configure
  • Features
    • Push features
      • Pushing scenario changes to Test Cases
      • Configuring the format of the synchronized test cases
      • Synchronizing Scenario Outlines
      • Update Test Case fields
      • Attach files to Test Cases using tags
      • Customization: Setting Test Case fields with default values
      • Customization: Update custom Test Case fields on push
      • Customization: Ignoring marked Test Case steps
      • Customization: Ignoring Test Case Tags
      • Customization: Ignore non-supported local tags
      • Customization: Mapping tags
      • Customization: Synchronizing scenarios from feature branches
      • Customization: Automatically link changed Test Cases
      • Customization: Synchronize linked artifact titles
      • Customization: Do not synchronize title
    • Pull features
      • Pulling Test Case changes to local scenarios
    • Common synchronization features
      • Configuration key
      • Remote scope
      • Linking Work Items using tags
      • Synchronizing Test Case hierarchies
      • Excluding scenarios from synchronization
      • Synchronization conflict resolution
    • Test result publishing features
      • Publishing test result files
    • General features
      • Jira authentication options
      • Configuration file
      • Hierarchical configuration files
      • Local test case conditions
      • Configuration wizards
      • SpecSync plugins
    • Customizations
    • Plugin list
  • Licensing
  • Guides
    • What is my Jira server URL?
    • Jira Test Case Management (TCM) solution
    • How to define the local feature-set to be synchronized
    • Filters and scopes
    • How to use SpecSync from build or release pipeline
    • How to upgrade to a newer version of SpecSync
    • How to attach files to test results
    • Using SpecSync with Cucumber
    • Using SpecSync with Cypress
    • Using SpecSync with Postman
    • Using SpecSync with TestNG
    • Using SpecSync on macOS or Linux
    • Using SpecSync inside a Docker container
    • Migrating from SpecSync v1 to v5
  • Changelog
  • Release Model and Roadmap
  • Downloads
  • Reference
    • Command line reference
      • init
      • upgrade
      • push
      • pull
      • publish-test-results
      • version
    • Configuration reference
      • toolSettings
      • local
      • remote
      • jira
      • knownRemotes
      • synchronization
        • push
        • pull
        • links
        • attachments
        • format
        • fieldUpdates
      • hierarchies
      • publishTestResults
      • specFlow
      • customizations
    • Compatibility
    • Older versions
  • Contact
    • SpecSync Support
    • Troubleshooting
    • FAQ
  • Project Website
Powered by GitBook
On this page
  • Step 1: Verify compatibility
  • Step 2: Review breaking changes
  • Step 3: Upgrade SpecSync
  • Step 4: Perform SpecSync upgrade command
  • Step 5: Review configuration changes and perform synchronization

Was this helpful?

  1. Guides

Migrating from SpecSync v1 to v5

PreviousUsing SpecSync inside a Docker containerNextChangelog

Last updated 2 months ago

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 changed to use semantic versioning from v5 on. This means that the changes that earlier were minor version changes (e.g. v3.3 to v3.4) are now represented with major version changes. The version that follows v3.4 was earlier planned as v3.5 (or v1.4 in case of SpecSync for Jira) but promoted now to v5.

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.

Step 1: Verify compatibility

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

Step 2: Review breaking changes

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.

The remaining breaking changes do not impact the most of usages, but please review the complete list of

Step 3: Upgrade SpecSync

Step 4: Perform SpecSync upgrade command

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.

dotnet specsync upgrade

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.

You do not have to configure all optional feature with the upgrade command in one step. You can of course configure these features also manually by modifying the configuration file, but you can also re-run the upgrade command later to configure these.

Step 5: Review configuration changes and perform 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.

dotnet specsync push --dryRun

If the result is good, you can do the final synchronization with the push command.

dotnet specsync push

Upgrade SpecSync to the latest v5 version. Please check the guide for detailed steps.

How to upgrade to a newer version of SpecSync
binary installation
Docker image
Changelog
breaking changes