Link Issues in VCS Commits

Software development teams often apply changes to the application code in response to an issue. These updates are usually applied in a version control system, or VCS. When you commit code to a VCS repository, you have the option to write a commit message that explains what you changed and why.

If your YouTrack server is integrated with a VCS repository, you can reference issues in your commit messages or in the branch names. These references are transformed into links that point from the repository, build, or commit to the issue in YouTrack. This feature is supported by the following integrations:

Build Server Integrations (TeamCity, Jenkins)
VCS Integrations (GitHub, Bitbucket, and GitLab)

Build Server Integrations

When your YouTrack server is integrated with TeamCity, you can reference issues when you commit changes to the version control system that is attached to your build server. To reference an issue, simply mention the issue ID in your comment. For example, fixed YP-2046.

TeamCity transforms the issue ID into a link to the corresponding YouTrack issue. When you move the pointer over the down arrow icon after the issue ID, a tooltip displays the issue summary and key fields:

A link to a YouTrack issue from a VCS commit in TeamCity.

When a commit message doesn't contain any issue references, but the branch name contains an issue ID, all commits to this branch automatically get linked to this issue.

In YouTrack, a link to the Change details page in TeamCity is added to the issue. All related commits are displayed in the issue activity stream.

VCS Integrations

A direct integration with a version control system lets you create links in the following ways:

Reference YouTrack issues in your commit messages to create links from the VCS to YouTrack.
Commit changes to branches containing issue IDs in their names to create links from the VCS to YouTrack.
Paste commit hashes into an issue summary, description, comment, or string-type custom field to create links from YouTrack to the VCS.

For example:

Commit message	Commit message displayed in VCS
In RDOC-2920, the procedures to pin and unpin comments on helpdesk tickets were added.	In RDOC-2920, the procedures to pin and unpin comments on helpdesk tickets were added.

Matching VCS Change Authors and YouTrack Users

To link VCS changes and process commands in commit messages, YouTrack has to find a user account that matches the author of the commit message. If a command is specified in the commit message, it is applied based on the access permissions that are granted to the user account in YouTrack. The user account is identified in different ways based on the type of connection to the version control system.

Connection Type	Description
TeamCity Integration	YouTrack checks the email address that is stored in the TeamCity user profile of the user who committed changes to the VCS. To recognize the TeamCity user who committed the change, the VCS username should be associated with the user profile in TeamCity.
VCS Integrations	For VCS integrations, the ability to apply commands to issues is limited to users who are members of the Committers group in the VCS integration settings. First, YouTrack searches for a user account whose email address matches the email address of the commit author. If found, the command is executed on behalf of this user. If none of the users in the Committers group has such an email address, YouTrack tries to find a match by name. It takes the value that is provided by the integrated VCS and compares it to the list of VCS usernames that are stored in the Hub accounts for users who belong to the Committers group. GitHub and GitLab provide the value that is stored as the Name. Bitbucket provides the value that is stored as the Nickname.

Connection Type

Description

TeamCity Integration

YouTrack checks the email address that is stored in the TeamCity user profile of the user who committed changes to the VCS. To recognize the TeamCity user who committed the change, the VCS username should be associated with the user profile in TeamCity.

VCS Integrations

For VCS integrations, the ability to apply commands to issues is limited to users who are members of the Committers group in the VCS integration settings.

First, YouTrack searches for a user account whose email address matches the email address of the commit author. If found, the command is executed on behalf of this user.
If none of the users in the Committers group has such an email address, YouTrack tries to find a match by name. It takes the value that is provided by the integrated VCS and compares it to the list of VCS usernames that are stored in the Hub accounts for users who belong to the Committers group.
- GitHub and GitLab provide the value that is stored as the Name.
- Bitbucket provides the value that is stored as the Nickname.

If the author of the commit message cannot be found in YouTrack, the command is not applied. The username is shown in red text on the VCS changes tab. The warning tooltip provides information that you can use to fix the problem.

There are basically two things that users can do to fix this problem:

Use the same email address for their accounts in YouTrack and the integrated VCS.
Add their name (or nickname for Bitbucket) to the list of VCS usernames in their Hub accounts.
GitHub and GitLab users often enter their username instead of the value that is stored as the Name in their profile. If you continue to have trouble applying commands in commit messages to your GitHub or GitLab repository, check your VCS usernames for your Name.
For example, if the legendary software engineer Linus Torvalds wanted to make sure his GitHub commits were properly linked to his VCS changes, he would need to add Linus Torvalds to the list of VCS usernames in YouTrack, not torvalds, which is his username in GitHub.

Last modified: 29 February 2024