links

This configuration section contains settings to configure how test case links should be updated based on the tags of the scenario.

Read more about synchronizing test case links in the Linking work items using tags concept description.

The following example shows how this sub-section can be used to specify a single link type.

{
  ...
  "synchronization": {
    ...
    "links": [
      {
        "tagPrefix": "bug"
      }
    ],
    ...
  },
  ...
}

The following example shows the available options within this sub-section. This example configures two link types.

{
  ...
  "synchronization": {
    ...
    "links": [
      {
        "tagPrefix": "story",
        "targetType": "User Story",
        "relationship": "Parent"
      },
      {
        "tagPrefix": "bug"
      },
      {
        "tagPrefix": "pr",
        "relationship": "Pull Request"
      },
      {
        "tagPrefix": "url",
        "relationship": "Hyperlink"
      },
      {
        "tagPrefix": "doc",
        "relationship": "Hyperlink",
        "linkTemplate": "https://docs.specsolutions.eu/specsync/{id}"
      }
    ],
    ...
  },
  ...
}

Settings

The links sub-section contains an array of link type configurations. Each of them is used to configure a link type. (The second example above configures two link types.)

For each link type configuration the following settings can be used.

Setting	Description	Default
tagPrefix	A tag prefix for specifying the relation for the scenario. E.g. specify story for linking product backlog items using a tag, like @story:123. The prefix can only contain word characters (letters, numbers, underscore).	mandatory
targetType	The type of the Azure DevOps work item the link refers to. It is verified at the time the link is established.	can link to any work item type
relationship	Specify the relationship for the created link. E.g. specifying Parent means that the linked work item will be the parent of the test case work item. Set to Hyperlink for linking arbitrary URLs (see details in linking feature page). Set to Pull Request for Azure DevOps Pull Requests and GitHub Pull Request for GitHub Pull Requests (see details in our guide).	Tests
linkTemplate	Specifies the HTTP link template of the related artifact (for GitHub Pull Request and Hyperlink relationship). The link template can use the specified value using the {id} placeholder.	no template used
disableTracking	Disables tracking of the created links. If tracking is disabled, SpecSync will never automatically remove the link even if the corresponding tag has been deleted.	false

synchronizationConfiguration reference