Customization: Update custom Test Case fields on push

The Custom field updates customization can be used to update arbitrary Test Case fields that are otherwise would not be changed by SpecSync.

The Custom field updates customization described here is an Enterprise feature.

In order to enable this customization, the customizations/customFieldUpdates section of the configuration has to be enabled. The complete reference of the configuration settings can be found in the customizations configuration reference.

The following example shows a basic configuration that initializes the Description field to a message containing the feature name.

{
  ...
 "customizations": {
    "customFieldUpdates": {
      "enabled": true,
      "updates": {
        "System.Description": "Synchronized from feature {feature-name}"
      }
    }
  }
  ...
}

The fields have to be identified using their reference name and not their label. E.g. the reference name for the Description field is System.Description. The reference names of the built-in fields can be found in the Azure DevOps documentation. The reference name of the custom fields can be obtained from the Azure DevOps project administrator, but usually they follow the format Custom.<your-field-name> (e.g. Custom.BusinessRule).

Specifying an update for a field that is also updated by SpecSync (e.g. Title) causes unpredictable behavior.

The specified value is a template to be used to update the field. The template can contain placeholders listed in the reference.

The specified fields are only updated when the Test Case would otherwise change. If the test case is up-to-date, the custom fields are not going to be updated.

To initialize custom fields with a default value, use the Field defaults customization.