Including Third-Party Reports in the Build Results

If your reporting tool produces reports in HTML format, you can extend TeamCity with a custom tab to show the information provided by the third-party reporting tool. The report provided by your tool can be then displayed either on the build results page, or on the project home page.

The general flow is as follows:

configure the build script to produce the HTML report (preferably in a zip archive);
configure publishing the report as the build artifact to the server: at this point you can check that the archive is available in the build artifacts;
configure the Report Tab to make the report available as an extra tab on the build or project level (see below)

Report tabs support project hierarchy. There are two types of tabs available:

Build-level: appears on the build results page for each build that produced an artifact with the specified name. These report tabs are defined in a project and are inherited in its subprojects. To override an inherited Report tab in a subproject, create a new report tab with the same name as the inherited one in the subproject.

Project-level: appears on the Project home page for a particular project only if a build within the project produces the specified reports artifact.

To configure a report tab, go to the Project Settings | Report Tabs and select the type of report tab you want to add.

For a project report tab, specify the following:

Option	Description
Tab Title	Specify a unique title of the report tab that will be displayed in the web UI.
Get artifacts from	Select the build configuration and specify the build whose artifacts will be shown on the tab. Select whether the report should be taken from the last successful, pinned, finished build or the build with the specified build number or the last build with the specified tag.
Start page	Specify the path to the artifacts to be displayed as the contents of the report page. The path must be relative to the root of the build artifact directory. To use a file from an archive, use the `path-to-archive!relative-path` syntax, e.g. `javadoc.zip!/index.html`. See the list of supported archives. You can use the file browser next to the field to select artifacts. Parameter references are supported here, e.g. `%\parameter%.zip!index.htm`

Option

Description

Tab Title

Specify a unique title of the report tab that will be displayed in the web UI.

Get artifacts from

Select the build configuration and specify the build whose artifacts will be shown on the tab. Select whether the report should be taken from the last successful, pinned, finished build or the build with the specified build number or the last build with the specified tag.

Start page

Specify the path to the artifacts to be displayed as the contents of the report page. The path must be relative to the root of the build artifact directory. To use a file from an archive, use the path-to-archive!relative-path syntax, e.g. javadoc.zip!/index.html. See the list of supported archives.

You can use the file browser next to the field to select artifacts. Parameter references are supported here, e.g. %\parameter%.zip!index.htm

For a build report tab, specify the following:

Option	Description
Tab Title	Specify a unique title of the report tab that will be displayed in the web UI.
Start page	Specify the path to the artifacts to be displayed as the contents of the report page. The path must be relative to the root of the build artifact directory. To use a file from an archive, use the `path-to-archive!relative-path` syntax, e.g. `javadoc.zip!/index.html`. See the list of supported archives. You can use the file browser next to the field to select artifacts. Parameter references are supported here, e.g. `%\parameter%.zip! index.htm`

Option

Description

Tab Title

Specify a unique title of the report tab that will be displayed in the web UI.

Start page

You can use the file browser next to the field to select artifacts. Parameter references are supported here, e.g. %\parameter%.zip! index.htm

Last modified: 20 April 2023