Icon

You are viewing the documentation of TeamCity 2018.x, which is not the most recently released version of TeamCity.
View this page in the latest 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

TeamCity can be integrated with your issue tracker to provide a comprehensive view of your development project. TeamCity detects issues mentioned in the comments to version control changes, turning them into links to your issue tracker in the TeamCity Web UI.

The integration is configured at the project level: the Project Administrator permissions are required. You can configure integration if you have multiple projects on both the TeamCity and the issue tracker server or if you are using different issue-trackers for different projects.

Enabling integration for the project also enables it for all its subprojects; if the configuration settings are different in a subproject, its settings have priority over the project's settings.

In this section:

Dedicated Support for Issue Trackers

TeamCity supports JIRA, Bugzilla, YouTrack and since TeamCity 10.0 GitHub, Bitbucket Cloud and TFS trackers out of the box. The Supported Platforms and Environments page lists supported versions.

When an integration is configured, TeamCity automatically transforms an issue ID (=issue key in JIRA, work item id in TFS) mentioned in the VCS commit comment into a link to the corresponding issue and the basic issue details are displayed in the TeamCity Web UI when hovering over the icon next to the issue ID (e.g. on the Changes tab of the build results).


Issues fixed in the build can also be viewed on the Issues tab of the build results.

On the build configuration home page, you can review all the issues mapped to the comments at the Issue Log tab. You can filter the list to a particular range of builds and view issues mentioned in comments with their states.

Recommendations on Using Issue Tracker Integration

To get maximum benefit from the issue tracker integration, do the following:

  • When committing changes to your version control, always mention the issue id (issue key) related to the fix in the comment to the commit.
  • Resolve issues when they are fixed (the time of resolve does not really matter).
  • Use Issue Log of a build configuration to get issues related to builds; turn on the "Show only resolved issues" option to only display the issues fixed in the builds.

Enabling Issue Tracker Integration

Requirements

Th information about the issues is retrieved by the TeamCity server using the credentials provided and then is displayed to TeamCity users.

This has several implications:

  • The TeamCity server needs direct access to the issue tracker. (Also, TeamCity does not yet support proxy for connections to issue trackers).
  • The user configured in the connection to the issue tracker has to have sufficient permissions to view the issues that can be mentioned in TeamCity. Also, TeamCity users will be able to view the issue details in TeamCity for all the issues that the configured user has access to.

Configuring connection

To enable integration, you need to create a connection to your issue tracker on the Project Settings | Issue Trackers page.The settings described below are common for all issue trackers:

Connection type

Select the type of your issue tracker from the list.

Display name

A symbolic name that will be displayed in the TeamCity UI for the issue tracker.

Server URL (Repository URL)

The Issue tracker URL

Username/Password (Authentication)

Credentials to log in to the issue tracker, if it requires authorization.

Additional authentication information or/and the details on how to specify strings to be recognized by TeamCity and converted to your tracker issue links is provided in the corresponding sections:

Integrating TeamCity with Other Issue Trackers

To integrate TeamCity with other issue trackers, configure TeamCity to turn any issue tracker issue ID mentions in change comments into links. See mapping external links in comments for details.

Dedicated support for an issue tracker can also be added via a custom issue tracker integration plugin.



See also:

  • No labels