SuiteResult.save_as_cml_markdown(file: Optional[str] = None, platform: str = 'github', attach_html_report: bool = True)[source]#

Save a result to a markdown file to use with [CML](

The rendered markdown will include only the conditions summary, with the full html results attached.

filefilename or file-like object

The file to write the HTML output to. If None writes to

platform: str , default: ‘github’

Target Git platform to ensure pretty formatting and nothing funky. Options currently include ‘github’ or ‘gitlab’.

attach_html_report: bool , default True

Whether to attach the full html report with plots, making it available for download. This will save a [suite_name].html file in the same directory as the markdown report.


name of newly create file.