- Associate a code commit with the bugs, feature requests, or other tracker artifacts that the code addresses.
- Associate a code commit with the task requiring its completion.
- Associate a code commit with an object in an integrated application.
- Associate a code commit with a requirements document.
Associate Code with Other Items While Committing
When you commit files to your source code repository, use the commit comment to quickly link your commit with one or more tracker artifacts or other TeamForge items.
Associations track the links between code and the bugs, feature requests, or other tracker artifacts that the code addresses. You also associate code commits with other TeamForge items, such as tasks or documents.
A project administrator can make associations mandatory for all code commits. When this is made mandatory, the following additional rules pertaining to code commit can also be set. These rules will be enforced when performing the code commit.
- the artifact and the commit must be in the same TeamForge project.
- the artifact must be in open state.
- the committer must be the owner of the specific artifact.
You can create tracker artifact associations from whatever interface you normally use to check code into your SCM repository. You do not have to log into TeamForge.
Use the same syntax for commits to CVS and Subversion repositories.
When making a code commit, add the associate command in the commit message like this: [<item id>], such as the TeamForge tracker artifact ID or task ID.
- TeamForge item IDs are always letters followed by four or more numbers, such as
- To associate a commit with multiple TeamForge items, separate the item IDs with commas.
- All associations are displayed in the ASSOCIATIONS tab of the Commit Details page.
- The Comment section lists the comments made with each commit.
Create Associations with Code That is Already Committed
At any time after a code commit is made, you can associate the code commit with other CollabNet TeamForge items, such as tasks, integrated application objects, or documents.
- Click SOURCE CODE from the Project Home menu.
- On the list of project repositories, select the repository containing the code commit with which you want to create an association.
- Click View Commits.
- On the Repository Details page, click the name of the commit with which you want to create an association.
- On the Commit Details page, click the ASSOCIATIONS tab.
- On the list of existing associations, click Add.
- In the Add Association Wizard window, select the items with which you want to associate the artifact:
ENTER ITEM ID - If you know the item’s ID, you can enter it directly.To associate an object in an integrated application from with TeamForge, use the [<prefix_objectid>] format.
Each integrated application displays its prefix on moving the mouse over the application name in the tool bar.
- ADD FROM RECENTLY VIEWED - Select one of the last ten items you looked at during this session.
- ADD FROM RECENTLY EDITED - Select one of the last ten items you changed.
- Click Next.
- You may add a comment in the ASSOCIATION COMMENT text box.
- Save your work.
Note: When you commit files to your source code repository, a source code commit notification mail is sent to users who are monitoring that source code repository. An option is provided at site level and user level to make sure whether the notification mail has to be sent or not. For more information on this, see Configure your Site’s Settings.
- Click Finish and Add Another to add additional associations.
- Click Finish to return to the Details page.
Click the Associations tab to view a graphical representation of all the associated items. Through the Association Viewer, you can choose to view associations in the form of a list or flip over to the Trace view to explore the layers of associations (including parent/child dependencies) laid out in a timeline. You can scroll across the Trace view by dragging the mouse over the association layer or use the ‘Previous’ and ‘Next’ arrows to view all the objects as events in a timeline.
While the Associations tab shows the count of the total number of associations, you can only view the most recent 500 associations when you click the Associations tab in case the artifact has more than 500 associations. You can, however, browse through the Association Viewer to view older associations.
You can click on each node on the graphical association viewer to filter and display the associated items in the table below the association viewer thus matching the number of associations provided on the selected node. For example, if the node that you select for filtering is having two associations on it, the table displays the two associated items as a result of the filtering process.