BDD living documentation using Cucumber and Asciidoctor based on Cucumber JSON execution output.
As a developer
I want to generate documentation based on my tests execution
In order to have better collaboration and understanding between my software and its users.
GIVEN I execute my cucumber tests using the json formatter
AND cucumber json output files are generated
WHEN I run Cukedoctor against those files
THEN I should have awesome living documentation generated by Asciidoctor
The following cucumber feature:
@a
Feature: One passing scenario, one failing scenario
@b
Scenario: Passing
Given this step passes
@c
Scenario: Failing
Given this step fails
will be converted by Cukedoctor (after tests execution) into the following document:
More examples of documentation generated by Cukedoctor can be found here. Feel free to fork it and contribute yours!
If you use maven and execute your cucumber tests through maven you can use cukedoctor-maven plugin. For more details see cukedoctor-maven-plugin.
To use Cukedoctor as a standalone jar you can download it here. For more details, see cukedoctor-main.
Cukedoctor converter is the basis for the above projects, it generates asciidoc files based on Cucumber json execution files. For more details see cukedoctor-converter.
Cukedoctor extension adds new features to generated documentation in order to let original document cleaner and make it easier to enable/disable those features. For more details see cukedoctor-extension.
Cukedoctor is available at Bintray and at Maven central.
Snapshots are available at maven central and published on each successful commit&build on travis.
You can use snapshots by adding the following snippets in pom.xml:
<repositories>
<repository>
<snapshots/>
<id>snapshots</id>
<name>libs-snapshot</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
</repositories>