Including Third-Party Reports in the Build Results

Skip to end of metadata
Go to start of metadata
You are viewing documentation of TeamCity 4.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.
Search

Searching TeamCity 4.x Documentation

Table of Contents

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 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:

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.
    Please note that for TeamCity versions prior to 4.0.1 if archive is used it should be placed in the root artifacts directory.
  • 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:


See Also:

Labels:

build build Delete
report report Delete
status status Delete
script script Delete
statistics statistics Delete
custom custom Delete
tab tab Delete
add add Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.