datapith/living-documentation

Expand on this idea of a Living Documentation for many aspects of a project, from the business goals to the business domain knowledge, architecture and design, processes and deployment.

Living Documentation

You don’t need to choose between Working Software and Extensive Documentation!

Table of Contents

• 1. Gradle plugin
  • 1.1. Usage

1. Gradle plugin

This module brings the ability to execute Cukedoctor within a gradle build.

The plugin just scans .json cucumber execution files in build dir and generates asciidoc documentation on build/cukedoctor folder.

1.1. Usage

Just declare the plugin in your build.gradle.kts:

plugins {
    id("io.datapith.cukedoctor").version(0.1.0)
}

cukedoctor {
}

and execute the task executeCukedoctor

❗	To generate cucumber .json output files just execute your tests with json formatter, example: @RunWith(Cucumber.class) @CucumberOptions(plugin = {"json:build/test-results/BddTests.json"} )