create_report_directive - generate a report of task results¶
New in version 0.4.
Generate report of task results in HTML format to given path.
Parameters¶
Parameter | Required | Description | Type | Default | Choices |
---|---|---|---|---|---|
artifactsdir |
yes | A path to the artifacts directory. |
str |
||
file |
yes | A path to a file containing the task results in the ResultYAML format. You must use either results or file parameter (exactly one). |
str |
||
path |
no | A path and a filename of the generated HTML report. You should always use relative paths, and ${artifactsdir} is considered to be the base directory. All missing directories will be created automatically. Example: reports/overview.html |
str |
report.html |
|
results |
yes | A string containing task results in the ResultYAML format. You must use either results or file parameter (exactly one). |
str |
||
template |
no | A path to a template to be used to generate a report. By default, a standard libtaskotron report template will be used. Example: /tmp/report.j2 |
str |
Exceptions¶
TaskotronDirectiveError
: if bothresults
andfile
parameters are used; or if their contents is not in a valid YAML format; or ifpath
cannot be created.