Adding custom reports

You can add custom reports to the Build Details page. Typically, the reports access the uploaded annotation file to present analysis of various aspects of the build. You must write a script/application that takes three arguments and produces an HTML/text output file.

The arguments are (in this order):

Generally, the script reads the build.xml file and creates a number of files. The first file it must create is the temporary HTML file. That file is named after the provided script name, followed by .html_tmp. This is where the HTML output is created. After the file is done, it is moved under the script name followed by .html.

If the file produces downloadable output (such as plain text), it produces a file named after the script name followed by .out_tmp (the temporary file where the file is created). After the file is created, it is moved under the script name followed by .out.

It is important that the script is well-behaved if failure occurs (for example broken XML). In this case, it must remove the temporary files so the Cluster Manager does not continue to show the Generating…​ state. CloudBees recommends generating an HTML output file (following the naming scheme above) that states the error, so users can learn of a failure.

Recommendation: Start generated output with a table element, which then may contain whatever is desired. To pick up common stylesheet settings, make the table and its cells of the mainWindow class.