Configuration reference
SpecSync can be configured using a json configuration file, by default called specsync.json
. This section contains a detailed reference of the SpecSync configuration options. For a general introduction about how SpecSync configuration works, please check the Configuration file page.
The Setup and Configure page contains information about how to initialize the configuration file.
A minimal configuration file
The following example shows a minimal configuration file.
{
"$schema": "http://schemas.specsolutions.eu/specsync4azuredevops-config-latest.json",
"compatibilityVersion": 3.3,
"remote": {
"projectUrl": "https://specsyncdemo.visualstudio.com/MyCalculator",
}
}
Configuration sections
The settings in the configuration file are grouped into different configuration sections. Each configuration section is a JSON object following the syntax:
{ // start of the file
...
"section1": {
// settings for section 'section1'
},
...
} // end of the file
Note: The leading comma (,
) after the curly brace close (}
) of section1
is not needed if this is the last section in the file.
Available configuration sections
The following configuration sections can be used. Click to the name of the section for detailed documentation.
toolSettings
— settings for the synchronization toollocal
— settings for the local repository (file system) containing the feature filesremote
— Settings for accessing the test cases on the remote Azure DevOps serverknownRemotes
— Specify connection and authentication details of Azure DevOps projects that are used by multiple synchronization projects. This setting can be used in user-specific configuration files.synchronization
— synchronization settingshierarchies
— Test Case hierarchy synchronization settingspublishTestResults
- test result publish settingsspecFlow
— settings related to synchronizing SpecFlow projects
* [`reqnroll`](configuration-reqnroll.md) — settings related to synchronizing Reqnroll projects {/%AzureDevOps%} * [`customizations`](configuration-customizations.md) — configure customizations
Last updated
Was this helpful?