You are viewing the documentation of TeamCity 8.x, which is not the most recently released version of TeamCity.
View this page in TeamCity 9.x documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.
Skip to end of metadata
Go to start of metadata

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 build artifacts to publish 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 as described here if you are running TeamCity 8.1 or above; for versions earlier than 8.1, refer to this section.


Starting from TeamCity 8.1, 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.
    You can override the inherited Report tab by creating a new report tab with the same name as the inherited one in the subproject.
  • Project-level: appears under the Project 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 page| Report Tabs page, click Create new report tab and proceed with the following options:

Option Description
Report tab type Type of the report tab (Build or Project-level)
Tab Title Specify a unique title of the report tab that will be displayed in the web UI.
Get artifacts from This field is available for project-specific report tabs only
Specify the build whose artifacts will be shown on the tab. Select whether the report should be taken from last successful, pinned, finished build or build with specified build number or last build with a 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.


Prior to TeamCity 8.1, the behavior is slightly different:

There are two types of report tabs available:

  • Build-level: appears on the build results page for each build that produced the artifact with the specified name. These are configured server-wide on Administration | Integrations | Report Tabs page.
  • Project-level: appears under the Project page for a particular project only if a build within the project produces the specified reports artifact. These are configured on Project administration > Report Tabs page.

To configure a report tab, go to the Integrations | Report Tabs page |(for the build-level tab) or project settings (for a project-level tab), click Create new report tab and proceed with the following options:

Option Description
Tab Title Specify a unique title of the report tab that will be displayed in the web UI.
Get artifacts from This field is available for project-specific report tabs only
Specify the build whose artifacts will be shown on the tab. Select whether the report should be taken from last successful, pinned, finished build or build with specified build number or last build with a 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.



See also:

Labels:
custom custom Delete
build build Delete
report report Delete
status status Delete
script script Delete
statistics statistics Delete
tab tab Delete
add add Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Sep 19, 2014

    How can one do this programmatically ? Say, for a plugin.

    1. Dec 08, 2014

      Léonard,

      Yes, you can add a tab via custom Java plugin to TeamCity, see Web UI Extensions.