Associate JIRA Issues to Version Control Commits

Associations between JIRA® issues and TeamForge-aware version control commits can be created via commit message references. Commits to TeamForge project repositories and external repositories that have been configured as EventQ sources are also supported.

Creating associations

  1. Using your desired terminal or IDE, instantiate a version control commit to your repository of choice.
  2. In the commit message, make reference to the JIRA ID(s) to which you wish to associate the commit surrounded by square brackets.

    Sample commit messages

    “[DEMO-123] This commit message will result in an association between
     JIRA issue DEMO-123 and this commit.”
    “[DEMO-123, DEMO-124] Here I’m associating two JIRA issues with project
     identifiers DEMO.”

Viewing Associations inside JIRA

  1. Navigate to the desired JIRA issue details page.
  2. Click the TeamForge tab.
  3. A list of immediate associations appears. In other words, these objects are directly associated to the JIRA issue in question.
  4. Click Trace to view the first three levels of the traceability chain.
    • All activities are mapped chronologically.
    • Lines indicate direct associations.
    • Use the "+" icon to explore further levels of traceability.


My associations do not appear. What should I do?
Verify the following:
  • Only repositories scoped to the configured TeamForge project will result in associations. That is, make sure the version control repository you’re using is a part of the TeamForge project that has been mapped to the JIRA project in question.
  • When a TeamForge project is first mapped to a JIRA project, the JIRA issues need to be synced into the TeamForge data store. Association will fail if you attempt to create an association between a commit and JIRA issue that has not yet been synced. Please refer to the Sync Issues functionality.
  • Make sure the association syntax is correctly using square brackets. Association syntax is case sensitive.