Skip to end of banner
Go to start of banner

TFS / VSTS check-ins synchronization

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

If you are interested in TFS / VisualStudio Team Services check-ins synchronization you may be also interested in our open source JIRA issue key check-in policy plugin for Visual Studio. Please take a look at its home page for further details.


Associating Check-In With a JIRA Issue

Associating using a check-in comment 

Associating a TFS / 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 / VSTS check-in / Git commit message, as shown below.



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 / VSTS Work Item

If you have properly set up your TFS4JIRA Synchronizer application to perform TFS / 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 / 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 changeset.

Scanning of changesets associated with a JIRA issue synchronized to a work item is done "lazily" for performance reason, because retrieving changesets 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 changeset is displayed. Subsequent opening of the issue page will show the changeset very fast, because it has already been scanned.

Viewing Changesets in JIRA

Once you associate the check-in with a JIRA issue you can view details of the checked in changesets in TFS check-ins tab on JIRA issue's view screen.

 

In addition to checked-in files, you can also view check-in comment and any non-empty check-in notes:

Elements of each changeset associated with an issue are clickable links.

 

You can also view check-ins associated with all issues in the JIRA project by navigating to TFS Check-ins project tab

 

Note

Only users with the View Version Control permission in JIRA are able to see the TFS / VSTS check-ins tab on the issue and project 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.

  • No labels