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

Was this helpful?

  1. Features
  2. Push features

Customization: Synchronize linked artifact titles

PreviousCustomization: Automatically link changed Test CasesNextCustomization: Do not synchronize title

Last updated 2 years ago

Was this helpful?

The Synchronize linked artifact titles customization can be used to synchronize linked artifact (issue) titles back to the local test case tags in @story:P01-123;This_is_the_story_title format. The link tags are only updated when the scenario is otherwise changed or when the --force option is used.

The link prefixes this behavior should be enabled for have to be explicitly listed in the configuration.

This might be useful when you would like to improve the readability of feature files, so that you do not only see the referred artifact ID, but also the descriptive title as well at the scenario tags.

The Synchronize linked artifact titles customization described here is an .

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

The following example shows a basic configuration that synchronizes the titles of the User Story work items, liked using the tag prefix story (a link without title would look be @story:P01-123).

If the User Story with ID P01-123 has the title "Allow marking pizzas as favorite", after a push synchronization is performed to a scenario linked to a User Story, the scenario tag will be updated to @story:P01-123;Allow_marking_pizzas_as_favorite.

{
  ...
  "synchronization": {
    ...
    "links": [
      {
        "tagPrefix": "story"
      }
    ]
  }
  "customizations": {
    "synchronizeLinkedArtifactTitles": {
      "enabled": true,
      "linkTagPrefixes": [ "story" ]
    }
  }
  ...
}

The customization uses ; by default to separate the artifact title from the link, but the separator can ba changed using the synchronization/linkLabelSeparator setting.

Enterprise feature
customizations configuration reference