SpecSync Documentation
Getting StartedConfigurationGuidesDownloads
Azure DevOps
Azure DevOps
  • Introduction to SpecSync for Azure DevOps
  • 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
      • Add new Test Cases to an Area or an Iteration
      • Mark Test Cases as Automated
      • Setting Test Case state on change
      • 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: Reset Test Case state after change
      • Customization: Automatically link changed Test Cases
      • Customization: Synchronize linked artifact titles
      • Customization: Add Test Cases to Suites
      • 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 using Test Suites
      • Include synchronized Test Cases to a Test Suite (deprecated)
      • Excluding scenarios from synchronization
      • Synchronization conflict resolution
      • Re-link scenarios to new Test Cases
    • Test result publishing features
      • Publishing test result files
      • Support for Azure DevOps Test Plan / Test Suite based test execution
      • Customization: Publishing test results to multiple Test Suites
    • General features
      • Azure DevOps authentication options
      • Configuration file
      • Hierarchical configuration files
      • Local test case conditions
      • Configuration wizards
      • SpecSync plugins
    • Customizations
    • Plugin list
  • Licensing
  • Guides
    • What is my Azure DevOps project URL?
    • How to define the local feature-set to be synchronized
    • Filters and scopes
    • How to synchronize automated test cases
    • How to use SpecSync from build or release pipeline
    • How to publish test results from pipelines using the VSTest task
    • How to use the SpecSync Azure DevOps pipeline tasks
    • How to link GitHub pull requests
    • How to upgrade to a newer version of SpecSync
    • How to attach files to test results
    • Using SpecSync with SpecFlow+
    • 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
    • How to handle Test Cases of multiple parallel application releases
    • Migrating from SpecSync v3 to v5
    • Migrating from SpecSync v2 to v3
    • Migrating from SpecSync v1 to v2
  • Changelog
  • Release Model and Roadmap
  • Downloads
  • Reference
    • Command line reference
      • init
      • upgrade
      • push
      • pull
      • publish-test-results
      • re-link
      • version
    • Configuration reference
      • toolSettings
      • local
      • remote
      • knownRemotes
      • synchronization
        • push
        • pull
        • automation
        • state
        • areaPath
        • iterationPath
        • links
        • attachments
        • format
        • fieldUpdates
      • hierarchies
      • publishTestResults
      • specFlow
      • reqnroll
      • customizations
    • Compatibility
    • Older versions
  • Contact
    • SpecSync Support
    • Troubleshooting
    • FAQ
  • Project Website
Powered by GitBook
On this page

Was this helpful?

  1. Reference
  2. Configuration reference

synchronization

This configuration section contains synchronization settings.

The following example shows the available options within this section.

{
  ...
  "synchronization": {
    "disableLocalChanges": false,
    "testCaseTagPrefix": "tc",
    "pull": {
      "enabled": true,
      "enableCreatingScenariosForNewTestCases": false
    },
    "automation": {
      "enabled": true,
      "condition": "not @manual"
    },
    "state": {
      "setValueOnChangeTo": "Design"
    },
    "areaPath": {
      "mode": "setOnLink",
      "value": "\\MyArea"
    },
    "iterationPath": {
      "mode": "setOnLink",
      "value": "\\Iteration1"
    },
    "links": [
      {
        "targetWorkItemType": "ProductBacklogItem",
        "tagPrefix": "pbi",
        "relationship": "Child"
      },
      {
        "tagPrefix": "bug"
      }
    ],
    "attachments": {
      "enabled": true,
      "tagPrefixes": [
        "wireframe",
        "specification"
      ],
      "baseFolder": "resources/files"
    },
    "format": {
      "useExpectedResult": false,
      "emptyActionValue": "N/A"
      "emptyExpectedResultValue": "N/A"
      "syncDataTableAsText": false,
      "prefixBackgroundSteps": true,
      "prefixTitle": true,
      "showParameterListStep": "whenUnusedParameters"
    }
  },
  ...
}

Settings

For sub-section settings, click on the name of the setting for details.

Setting
Description
Default

disableLocalChanges

false

testCaseTagPrefix

The tag prefix for specifying the test cases. E.g. specify testcase for referring to test cases using a tag, like @testcase:1234.

tc

tagPrefixSeparators

Specifies one or more tag prefix separators to recognize in order to be able to support links like @story=42. For creating tags, the first separator is used.

[":"] (only : can be used as separator)

linkLabelSeparator

Specifies the link label separator in order to be able to support links like @story:42,this_is_the_title.

;

Settings to configure how the test case state field should be updated.

PreviousknownRemotesNextpush

Last updated 1 year ago

Was this helpful?

Disables changing feature files in the local repository. If set to true (called build server mode), only those changes will be performed that do not need any change in the local feature files. Linking new scenarios or pulling changes from test cases will be skipped. Can be overridden by the --disableLocalChanges . See for details.

Settings to configure the push behavior. See

Settings to configure the pull behavior. See for details

Settings to configure synchronizing automated test cases. See for details.

Settings to configure how the test case area path field should be updated. See for details.

Settings to configure how the test case iteration path field should be updated. See for details.

Settings to configure how test case links should be updated based on the tags of the scenario. See for details.

Settings to allow attaching files to Test Cases during synchronization using tags. See for details.

Settings to configure the format of the synchronized test case. See for details.

Specifies how the fields of the Test Case that are not managed by SpecSync should be updated. It can contain update rules in "key": <VALUE> format, where key is a field name or identifier and <VALUE> is the value to update to or an update specifier. See for details.

Configuration reference
command line option
Synchronizing test cases from build
push
Pushing scenario changes to Test Cases
pull
Two-way synchronization
automation
Synchronizing automated test cases
state
areaPath
Add new test cases to an Area or an Iteration
iterationPath
Add new test cases to an Area or an Iteration
links
Linking work items using tags
attachments
Attach files to Test Cases using tags
format
Configuring the format of the synchronized test cases
fieldUpdates
Update Test Case fields