HTML Report Plugin

A generic plug-in to display a report from an HTML file.

Version

Available from version 1.5

Examples

Minimalist

<htmlReportPlugin description="Document Report" actionName="viewReport" htmlFileName="reports\document.html" />

In Context

<buildPlugins>
  <buildReportBuildPlugin>
    <xslFileNames>
      <xslFile>xsl\header.xsl</xslFile>
      <xslFile>xsl\modifications.xsl</xslFile>
    </xslFileNames>
  </buildReportBuildPlugin>
  <buildLogBuildPlugin />
  <htmlReportPlugin description="Document Report" actionName="viewReport" htmlFileName="reports\document.html" />
</buildPlugins>

Configuration Elements

Element	Description	Type	Required	Default	Version
actionName	The name of the action - this will be used in the URL for the plug-in. This must be unique for the dashboard (e.g. there cannot be another action or plug-in with the same name.	String	Yes	n/a	1.5
description	The description of the plug-in. This will be displayed as the title of the link.	String	Yes	n/a	1.5
excludedProjects	The projects to exclude from this plug-in. This is currently not implemented.	String array	No	None	1.5
htmlFileName	The name of the file to display. See the notes below on what are valid names.	String	Yes	n/a	1.5
includedProjects	The projects to include in this plug-in. This is currently not implemented.	String array	No	None	1.5

Notes

HTML Source Location

This plug-in can display any file that is in the build folder under artefacts folder for the project. It cannot display files from any other location (for security reasons).
Files can be published to a build folder using the File Merge Task. This will automatically generate the correct folder structure for the HTML reports.

File Names

All file names are relative to the build folder. Files directly in the folder can be specified, as well as folders in sub-folders. For example both report.html and documents\report.html are valid file names.
Absolute filepaths are not allowed (e.g. c:\somewhere\report.html).
If the project's artefact folder was d:\data\ and the build label was 1.0.1, then report.html would come from d:\data\1.0.1\report.html.

Automatically Generated

Documentation generated on Tuesday, 6 Apr 2010 at 9:32:07 PM
Using assembly version 1.6.7109.1

Document generated by Confluence on Jan 23, 2011 08:52