TeamCity Cloud 2022.10 Help

Azure Board Work Items

You can integrate TeamCity with Azure Board Work Items (or Team Foundation Work Items) to provide links to work items from the TeamCity UI. TeamCity supports Azure DevOps Server (previously named Team Foundation Server — versions 2012 or later) and Azure DevOps Services.

Displaying Links to Work Items in TeamCity UI

When integration with Azure Board Work Items is enabled, TeamCity automatically detects work item IDs mentioned in the comments of VCS commits. It transforms these IDs into links to the corresponding work items and displays them to TeamCity users in the UI:

  • To see the basic details of a work item in the TeamCity UI, open the Changes tab of the related build’s results and hover over the icon next to the work item ID.

  • Work items fixed in the build can be viewed on the Issues tab of the build results.

  • To view work items related to a whole build configuration (not only to individual builds), use the Issue Log tab of the Build Configuration Home page. You can filter the list to a particular range of builds and/or enable the Show only resolved issues option to display only issues fixed in the builds.

Additionally, if your changeset has related work items, TeamCity can retrieve information about them and display information in the UI even if no comment is added to the changeset.

To get the maximum benefit from the integration with Azure Board Work Items, follow these recommendations:

  • When committing changes to your version control, always mention the work item ID related to the fix in the comment to the commit.

  • Mark fixed work items as Resolved in the issue tracker to display them with the Fixed status in TeamCity logs (the time of resolve does not really matter).

Configuring Connection to Azure Board Work Items

Enabling TeamCity integration with Azure Board Work Items requires Project Administrator permissions as it is configured at a project level. Note that enabling integration for a project enables it for all its subprojects as well. If the settings are different in a subproject, they have priority over the parent project's settings.

To enable the integration, create a connection to Azure Board Work Items on the Project Settings | Issue Trackers page and specify the following settings:

Setting

Description

Connection Type

Select Team Foundation Work Items from the list.

Display Name

Specify the connection name to distinguish it from the other connections.

Server URL

Enter Azure DevOps Server URL in the following format:

  • Azure DevOps Services: https://dev.azure.com/<organization>/<project>

  • Azure DevOps Server: http[s]://<host>:<port>/tfs/<collection>/<project>

Username

Specify a user to access the Azure DevOps Server. This can be a username or DOMAIN\UserName string.
Leave empty to let Azure DevOps select a user account that is used to run the TeamCity Server.

Password

Enter the password for the user entered above.

To authenticate via access token instead of password, leave the Username field empty and enter your access token as Password. You can create a personal access token in your Azure DevOps account. Set the Code access scope to Work Items (read, write, and manage) in the repositories you are about to access from TeamCity.

Pattern

Specify a Java Regular Expression pattern to recognize a work item ID in the comment text. The matched text (or the first group if there are groups defined) is used as the work item number. The most common case is #(\d+) — this will extract 1234 as the work item ID from the text Fix for #1234.

Last modified: 21 November 2022