TeamCity 4.0 Help

Including Third-Party Reports in the Build Results

TeamCity can be extended with a custom tab to include information provided by third-party reporting tools.

If your reporting tool produces a report in HTML format, you can add a new tab to the build results page which will show the report. To do this, specify the report as an Build Artifact and modify the configuration to instruct the server to display the report whenever it is found in the build artifacts.

To enable a report tab:

  1. For the build configuration, that produces a report, add an archive or directory to the Artifact paths of the Build Runner.

  2. Add the following line within the <server> tag of the <TeamCity data directory> /config/main-config.xml file:

<report-tab title="A Report" auxiliary-id="A Report" basePath="<report archive or directory>" startPage="index.html" />

where:

  • title is a unique title of the report tab that will be displayed in the web UI

  • basePath is an archive or directory that contains the generated report. The path should be relative, it will be used to get the appropriate file or directory from the build's artifacts. Examples are javadoc or report.zip to reference a directory or an archive in the root of build's artifacts.

  • startPage is a relative path of the start page within the report archive or directory.

Once recognized, a tab might look like "OpenAPI JavaDoc" tab on this example:

Report tab

Last modified: 20 April 2023