SpecFlow

SpecFlow+ LivingDoc

Generate automatically validated specification scenarios as living documentation and share it easily with your team.

Get started View the docs
THENGIVENWHEN;;;

What is SpecFlow+LivingDoc?

LivingDoc is an extension to our SpecFlow-BDD-Framework. LivingDoc displays Gherkin feature specifications and their automated validation results as a single source of truth outside of an IDE – within your browser.

Reporting made easy!

Automatically generate, display, share, review, and discuss your scenarios with your stakeholders via any browser

GIVENWHENTHENGIVENWHENTHEN

Scenarios

Display requirements (Gherkin feature files) from your source control directly in your browser

Single source of truth

Automatically updated with every new build of your CI/CD pipeline

Pimp your scenarios

Add images and link your scenarios to your favorite ALM system

Analyze

Get insights into test results, features, and automation health.

How does LivingDoc support daily business?

Watch how SpecFlow+LivingDoc would integrate into your daily development tasks.

As we are practicing BDD, let’s assume the discovery- & formulation phase is already done.

Day 1

As a PO:
Before the daily standup, I open LivingDoc and look at the work in progress.

First, I notice the existing functionalities that have already been automated by a green tick-mark.

LivingDoc Day 1

Day 2

A mixed bag of green (passed), red (failed), and grey (pending) marks indicate the work in progress. Clicking on the analytics tab shows a summary of features, scenarios, and steps.
The steps summary also shows the number of unbound steps.

LivingDoc Day 2

Day 3

All pending steps are executing now with some pass and fail results. There are now no unbound steps, and the team delivered as promised.

LivingDoc Day 3

How to generate LivingDoc

1

LivingDoc as a dedicated Azure DevOps extension

SpecFlow+LivingDoc for Azure
2

Using Any Other CI/CD Tool

Install the SpecFlow LivingDoc extension. Go to your Build Pipeline and add LivingDoc as a build step in your pipeline

Local copy of the Repo

CI/CD-Tool

Add a CLI-step in your pipeline, which generates the LivingDoc

SpecFlow+LivingDoc Generator

Latest releases of LivingDoc

SpecFlow Suite 3.9

2021-06-21
3.9
Afflected Products: SpecFlow, SpecFlow+ LivingDoc, SpecFlow+ Runner

We are excited to announce that SpecFlow 3.9 is finally publicly released. In this release we fixed several bugs and tried to solve a long running issue with SpecFlow and Mac OS.

A big Thank You to all our amazing contributors!

As always this release would not be possible without you.

Here is a list of all the contributors to SpecFlow since the previous release:

Read more

SpecFlow Suite 3.8

2021-05-21
3.8
Afflected Products: SpecFlow, SpecFlow.ExternalData, SpecFlow+ LivingDoc, SpecFlow+ Runner

We are excited to announce that SpecFlow 3.8 is finally publicly released. The biggest new feature we added in this version is a dedicated API for additional output (text and files) for your scenarios.

Yes, you could this before by using the APIs of various test runners, but you had to have prior knowledge on how to use them. Also, having an abstraction layer makes it possible for us to hook into it and display further valuable information. The first thing we did with this new extension point is to bring the output to SpecFlow+ LivingDoc.

Test Output in SpecFlow+ LivingDoc

You can learn more about the Output API and its usage in our documentation. To use it, you simply update the SpecFlow NuGet packages to the latest version, and you are ready to go.

We developed this because our community upvoted this feature on our feature request list. The feature request became very popular; therefore, we decided to adjust our backlog priorities to implement this swiftly and bring more value to our users.

A big Thank You to all our amazing contributors!

As always this release would not be possible without you.

Here is a list of all the contributors to SpecFlow since the previous release:

Read more

SpecFlow Suite 3.7

2021-02-17
3.7
Afflected Products: SpecFlow, SpecFlow.ExternalData, SpecFlow+ LivingDoc, SpecFlow+ Runner

What is new?

We were finally able to fix a major bug that happens during the parallel execution of scenarios and was a problem for a lot of users. Parallel execution on feature-level (one scenario of multiple features is running in parallel) should work now without problems. If you have still one, please create an issue on GitHub.

A big Thank You to all our amazing contributors!

As always this release would not be possible without you.

Here is a list of all the contributors to SpecFlow since the previous release:

Read more
See all releases

Feature Request?

Is something missing within SpecFlow? Submit your feature request or contribute to it on your own!

Submit request