The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Cucumber Living Documentation Plugin

livingDocs: Living documentation

Generates BDD living documentation based on Cucumber tests results

This plugin expects Cucumber json output from your tests to generate the documentation of your project. The plugin uses the json report to produce html and pdf documentation that will be available after build execution.

To build the documentation from your tests results you need to use cucumber json formatter:

    import cucumber.junit.Cucumber;
	import org.junit.runner.RunWith;

	@RunWith(Cucumber.class)
	@Cucumber.Options(format = "json:target/cucumber.json")
	public class CucumberTest {
	}

Note that format option was replaced by plugin in newer cucumber versions.

If you face java.lang.ClassCircularityError: org/jruby/RubyClass you probably hit issue JENKINS-31019, to solve that need to upgrade your installation to v1.640 or newer.

Cucumber living documentation plugin is backed by Cukedoctor, a BDD living documentation tool which integrates Cucumber. and Asciidoctor

  • featuresDir (optional)
    • Type: String
  • format (optional)
    • Values: HTML, pdf, ALL
  • toc (optional)
    • Values: RIGHT, LEFT, CENTER
  • numbered (optional)
    • Type: boolean
  • sectAnchors (optional)
    • Type: boolean
  • title (optional)
    • Type: String
  • hideFeaturesSection (optional)
    • Type: boolean
  • hideSummary (optional)
    • Type: boolean
  • hideScenarioKeyword (optional)
    • Type: boolean
  • hideStepTime (optional)
    • Type: boolean
  • hideTags (optional)
    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.