livingdoc feature-data - Generates living documentation from pre-parsed features stored in a Feature Data JSON file.
livingdoc feature-data [-t|--test-execution-json <testExecutionJson>] [--title <title>] [--work-item-url-template <workItemUrlTemplate>] [--work-item-prefix <workItemPrefix>] [--binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>] [-o|--output <output>] [--output-type <HTML|JSON>] <featureDataJson>
Relative (from the working directory) or absolute path of the Feature Data JSON. If the path to the file contains a space, make sure to enclose it in quotes.
The Feature Data JSON is different from the TestExecution.json generated by the SpecFlow.Plus.LivingDocPlugin.
You can create a Feature Data JSON with running the LivingDoc CLI and using the
--output-type JSON option. This can be helpful if you have a multiple step pipeline where you want to first
generate the the Feature Data JSON and in a later step further enhance it with a TestExecution.json.
Relative (from the working directory) or absolute path of the test execution JSON files generated by the SpecFlow.Plus.LivingDocPlugin during test execution.
NOTE: If you used the SpecFlow+ Runner with its parallel execution features you may end up with multiple JSON files.
You can include multiple JSON files separated by a space in the command-line tool as per below:
-t|--test-execution-json <testExecutionJson_1 testExecutionJson_2 ... >
Use a wild card (*) to include them all:
Check this guide for further info on this subject.
--binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>
Relative (from the working directory) or absolute path of the SpecFlow binding assemblies separated by space. The <TestAssembly> does not have to be specified as a binding assembly because it is always scanned for SpecFlow bindings.
Relative (from the working directory) or absolute path to the generated output file. Default value:
NOTE: If the directory given in the “–output” path does not already exist, LivingDoc CLI will automatically create the output directories in the given output path.
The last element in a path ending in a slash or backslash is treated as a directory (not a file name),if a directory with the same name does not exist.
For example, report in –output ./out/out2/report/ is treated as a directory if it does not exist yet. However, if a directory named report does exist in the path, then report is treated as a directory regardless of the path ending in a slash/backslash or not.
The type of output file to be generated. The
HTMLoutput is the living documentation report. The
JSONoutput contains the pre-parsed feature data optionally extended with further information (test execution results, binding information, etc.). Default value:
The name of the special tag you mark the scenarios with to link them to the corresponding work items.
The URL template to use to generate the external links. e.g:
The title/header of the generated document. Default value: The root folder node’s name.