NOTE: The Manuscript integration with Team Foundation Server has been ported over as is from FogBugz. We have only tested these steps with Team Foundation Server versions up to 2013. Please contact support if you need to work with a newer version
There are two aspects to setting up Manuscript-Team Foundation Server integration:
- Getting Team Foundation Server (TFS) to transmit changes to Manuscript
- Getting Manuscript to provide links to Team System Web Access 2008, the web-based repository browser
Setting up the repository in Manuscript
The starting point for setting up source control integration is to create the repository in Manuscript. To do so, log into Manuscript as an administrator and go to Admin | Source Control. Click Create New Repository. In the resulting dialog, select Team Foundation as the type and give the repository a display name. Click Next.
In the resulting dialog, download the script necessary to get TFS to transmit changes to Manuscript and choose whether you want Manuscript to provide links to your check-ins. You can change this setting later by clicking the Edit icon next to the repository on the Admin | Source Control page.
Diff and log links
Manuscript can provide links to a site that displays diffs and logs for changes connected to a case. In version 2008, Team Foundation Server itself does not include web-based diff and log viewing capabilities, but Microsoft provides a free application called Team System Web Access 2008 that can display diffs and logs from a web browser. TFS 2010 includes this by default. Once it is installed and working, set the path to it in the New Repository dialog and click OK to complete the setup. For TFS 2010, this should be
Note: Team System Web Access 2005 (and therefore Team Foundation Server 2005) will not work with web-based diffs and logs, since it doesn’t allow direct links to logs and diffs.
Getting Team Foundation Server to transmit changes to Manuscript
On your application tier Team Foundation server, run the register-fogbugz.bat script you downloaded above. The script will prompt you to confirm the Team Foundation Server URL; it will then register Manuscript for notifications. After successfully completing this step, you can delete the batch file; it is no longer needed.
Entering case numbers using Team Foundation Server
When you commit a change using Team System, include a single line of the form
BugzID: 1234 in the log after the other comments, where 1234 is the case number you want to link. For example: