Capture Report from File
  • 17 Feb 2022
  • 1 Minute to read
  • Dark
    Light
  • PDF

Capture Report from File

  • Dark
    Light
  • PDF

Article summary

This is generated from the built in components of BuildMaster 7.0.0, 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 Report from File

Captures a plain text or HTML file as a build report.

Script usage:

Capture-FileReport(
	Path: <text>,
	[Html: <true/false>],
	Name: <text>
);

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

Arguments:

NameFormatScript UsageUsage Notes
☆ From file (default)
text
Path
 This argument is required.
HTML format
true/false
Html
☆ Report name
text
Name
 This argument is required.

Example:

# create a report from the files in the working directory
Capture-FileReport(
    Name: Diff Tool Output,
    Index: index.html
);

Was this article helpful?