BuildMaster Documentation

Reports - Capture HTML Report from Directory

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Capture HTML Report from Directory

Captures all HTML files from a directory into a browsable build report.

Script usage:

Capture-HtmlDirectoryReport(
	[FromDirectory: <text>],
	Index: <text>,
	[Preview: <text>],
	Name: <text>
);

This operation may be prefixed with Reports::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
From directory
text
FromDirectory
HTML index page
text
Index
The HTML index page is the first page that is viewed when the report is opened and should contain links to other pages captured in the report. This argument is required.
Preview page
text
Preview
The preview page is displayed on the build overview page.
Report name
text
Name
This argument is required.

Note: At a minimum, the specified index file is required. The preview HTML file is optional, but may be desirable to provide a quick summary of the report contents. Links to other pages in the report should be relative from the root directory captured.

Example:

# create a report from the files in the working directory
Capture-HtmlDirectoryReport(
    Name: Files In Working Directory,
    Index: index.html,
    Preview: preview.html
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master