Associating Check-In With a Jira Issue
Associating using a check-in comment
Associating a TFS / Azure DevOps (formerly VSTS) check-in with a Jira issue is very simple and straightforward. The only thing that you have to do is type an issue key as a part of your TFS / Azure DevOps (formerly VSTS) check-in / Git commit message, as shown below. The key can be anywhere in the comment.
This is the standard Jira way of associating sources with issues, the same method is used in other types of source code repositories (e.g. Subversion).
Associating using a check-in note
It is also possible to associate a check-in with a Jira issue by typing an issue key as a part of any check-in note associated with the check-in. Name of the check-in note is not important - all notes are scanned, but it may be a good idea to name the check-in note accordingly and perhaps even make it mandatory in order to enforce a Jira integration policy.
Associating using TFS / Azure DevOps (formerly VSTS) Work Item
If you have properly set up your TFS4JIRA Synchronizer application to perform TFS / Azure DevOps (formerly VSTS) to-and-from Jira issues synchronization and (in case of Jira Cloud environment) exposed it to web requests from the Internet (see Settings for JIRA Cloud), associating check-ins with Jira issues is even easier - actually it is fully automatic. All you need to do is associate your check-in with a TFS / Azure DevOps (formerly VSTS) work item and the Synchronizer will take care of the rest - it will find the work item's matching issue and when you open that issue it will display the change-set.
Scanning of change-sets associated with a Jira issue synchronized to a work item is done "lazily" for performance reason, because retrieving change-sets from a work item, which in turn must be found for an issue, is a costly operation. Therefore when you initially open a Jira issue page, there will be a noticeable delay before the change-set is displayed. Subsequent opening of the issue page will show the change-set very fast, because it has already been scanned.
Viewing Change-sets in Jira
In side panel of Jira issue page you will see "TFS Check-ins" section which contains number of check-ins associated with that issue. Click the link to open pop-up with check-ins details
In addition to checked-in files, you can also view check-in comment and any non-empty check-in notes:
Each filename is a clickable link which leads to file content in appropriate version or file difference to previous version (depending on change type)
Only users with the View Development Tools permission in Jira are able to see the TFS Check-ins section on the issue page. This is Jira's standard way of limiting access to viewing source code to authorized users and TFS4JIRA obeys this convention.
Make sure you grant this right to appropriate users. See this page for details.
This page has no comments.