Logo
latest

Step-by-step guides

  • Step-by-step guide for LivingDoc Azure DevOps
  • Step-by-step guide for LivingDoc Generator

LivingDoc IN AZURE DEVOPS

  • Generating LivingDoc for Azure DevOps
  • Azure DevOps extension installation
  • Adding a Build Step
  • Configuring the Build Step in DevOps
  • Configuring the Build Step in YAML

LivingDoc Generator

  • Generating LivingDoc using CLI
  • LivingDoc Plugin Setup
  • Installing the CLI tool
  • Using the CLI tool
  • livingdoc feature-folder
  • livingdoc test-assembly
  • livingdoc feature-data

Viewing LivingDoc

  • Azure DevOps Extension
  • Generator - CLI Tool
  • Test results
  • Analytics
  • Unused Step Definitions
  • Finding keywords in LivingDoc

Enhancing LivingDoc

  • Embedding Images & Markdown
  • Linking within LivingDoc
  • Link to ALM systems
    • External links in Azure DevOps
    • External Links in LivingDoc Generator
  • Editing Feature Files in Azure DevOps
  • Documentation Languages
  • Adding branch name to LivingDoc

Sharing LivingDoc

  • Sharing & Publishing SpecFlow+LivingDoc

Guides

  • SpecFlow+LivingDoc Generator Migration v3.4 to v3.5
  • Troubleshooting
  • Merging multiple test results

Version History

  • Azure DevOps Extension
  • LivingDoc Generator
  • Known issues and limitations
SpecFlow+ LivingDoc
  • »
  • Link to ALM systems
  • View page source
Overview | SpecFlow | SpecFlow+LivingDoc | SpecFlow+Runner | SpecFlow+Excel | SpecMap

Link to ALM systems¶

Features and Scenarios can be linked to external issues/tickets/work items/etc. by using Gherkin tags. These special tags allow quick navigation from LivingDoc to your application lifecycle management (ALM) software of choice, allowing you quick access to additional information such as status of the ticket, assigned person, and work item status.

External links in Azure DevOps¶

The SpecFlow+LivigDoc Azure DevOps extension makes linking to Azure DevOps work items easy.

For example, if you define a work item prefix as WI: in your Azure DevOps build step, then tags starting with this prefix will be converted to links when parsed by LivingDoc.

For instance, @WI:7 will create a link to work item “7” in Azure DevOps:

Linking

External Links in LivingDoc Generator¶

You can configure external ALM linking in the LivingDoc Generator too.

You can do this by creating external links to a specific work item in any ALM system.

For example, if you define the Gherkin tag prefix as WI and you want link to Azure DevOps then you can use the following command to generate the documentation:

livingdoc test-assembly C:\Work\MyProject.Specs\bin\Debug\netcoreapp3.1\MyProject.Specs.dll --work-item-prefix WI --work-item-url-template https://dev.azure.com/specflow/BookShop/_backlogs/backlog/BookShop%20Team/Stories/?workitem={id}

or in Atlassian Jira:

 --work-item-url-template https://jira.atlassian.com/browse/YOURPROJECT-{id}

Then tags starting with this prefix will be converted to links when parsed by LivingDoc.

> Note: If you are using PowerShell to generate LivingDoc, you must have the --work-item-url-template URL in single quotes to avoid getting errors:

livingdoc test-assembly C:\Work\MyProject.Specs\bin\Debug\netcoreapp3.1\MyProject.Specs.dll --work-item-prefix WI --work-item-url-template 'https://dev.azure.com/specflow/BookShop/_backlogs/backlog/BookShop%20Team/Stories/?workitem={id}'
Previous Next

Need additional help? Ask our community or check our FAQs.

© Copyright SpecFlow Team. Revision f84e7c5d.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.