README

   1 Team Foundation is a "collection of collaborative technologies that
   2 support a team effort to deliver a product." It includes bug tracking,
   3 source control, and other features (*).
   4
   5 For example, Microsoft's CodePlex site (http://codeplex.com/)
   6 uses a Team Foundation Server for the source control backend.
   7
   8 For instructions on how to build and install this software,
   9 see the file INSTALL.
  10
  11
  12 Namespaces under Development
  13 -----------------------------------------------------------------
  14
  15   Microsoft.TeamFoundation
  16   Microsoft.TeamFoundation.Common
  17   Microsoft.TeamFoundation.Client
  18   Microsoft.TeamFoundation.VersionControl.Client
  19   Microsoft.TeamFoundation.VersionControl.Common
  20
  21
  22 The TF tool
  23 -----------------------------------------------------------------
  24
  25 An in progress implementation of the Team Foundation client, tf.exe,
  26 can be found in tools/tf/. If found, it will make use of libmagic
  27 to compute file permissions, as TF servers do not track/store
  28 permissions.
  29
  30 Documentation on the tool can be found on msdn at:
  31 http://msdn2.microsoft.com/en-us/cc31bk2e(VS.80).aspx
  32
  33 Supported Informational Commands:
  34   dir, get, labels, status, view, workfold, workspace, workspaces,
  35         history, properties, ls-files, permissions
  36
  37 You can now track a repository using the
  38 following commands:
  39
  40   tf /server:<server-ip> /login:<domain>\\<username>,<password> workspace /new "<workspace name>;<username>";
  41   tf /server:<server-ip> /login:<domain>\\<username>,<password> workfold "$/<project name>" /usr/local/src/somedir
  42
  43 Then as often as you like run:
  44   tf /server:<server-ip> /login:<domain>\\<username>,<password> /recursive get /usr/local/src/somedir /workspace:someworkspace
  45
  46 Supported Utility Commands:
  47   add, checkin, edit/checkout, delete, get, undo, rename
  48
  49   These utility commands will modify the state of the server, but checkin
  50   has a bug which prevents the changes being completed. undo can be used to
  51   revert add/delete/edit type changes on the server.
  52
  53
  54 Running the Unit Tests
  55 -----------------------------------------------------------------
  56
  57 Most of the unit tests require a working TeamFoundation server. Currently, the unit
  58 tests use the following environment variables to configure which server, user account,
  59 password, project, etc. to use for testing purposes.
  60
  61 export TFS_URL=<url to server, eg. http://192.168.0.1:8080/>;
  62 export TFS_USERNAME=<your-username>;
  63 export TFS_DOMAIN=<your-domain>;
  64 export TFS_PASSWORD=<your-password>;
  65 export TFS_PROJECT=<a top-level project name, eg. MyProject>;
  66
  67
  68 TFS Web Services
  69 -----------------------------------------------------------------
  70 Here's the list of available TFS web services, as noted by
  71 a post at http://converttostring.com/archive/2007/03/01/359.aspx
  72
  73 /Services/v1.0/AuthorizationService.asmx
  74 /Services/v1.0/CommonStructureService.asmx
  75 /Services/v1.0/EventService.asmx
  76 /Services/v1.0/GroupSecurityService.asmx
  77 /Services/v1.0/ProjectMaintenance.asmx
  78 /Services/v1.0/ProcessTemplate.asmx
  79 /Services/v1.0/Registration.asmx
  80 /Services/v1.0/ServerStatus.asmx
  81
  82 /Warehouse/v1.0/WarehouseController.asmx
  83 /Warehouse/v1.0/WarehouseController.asmx
  84
  85 /Build/v1.0/BuildStore.asmx
  86 /Build/v1.0/BuildController.asmx
  87 /Build/v1.0/Integration.asmx
  88 /Build/v1.0/Integration.asmx
  89 /Build/v1.0/Integration.asmx
  90 /Build/v1.0/PublishTestResultsBuildService.asmx
  91
  92 /WorkItemTracking/v1.0/ClientService.asmx
  93 /WorkItemTracking/v1.0/ConfigurationSettingsService.asmx
  94 /WorkItemTracking/v1.0/Integration.asmx
  95 /WorkItemTracking/v1.0/Integration.asmx
  96 /WorkItemTracking/v1.0/Integration.asmx
  97 /WorkItemTracking/v1.0/Integration.asmx
  98
  99 /VersionControl/v1.0/repository.asmx
 100 /VersionControl/v1.0/administration.asmx
 101 /VersionControl/v1.0/integration.asmx
 102 /VersionControl/v1.0/item.asmx
 103 /VersionControl/v1.0/upload.asmx
 104
 105 /Build/v1.0/PublishTestResultsBuildService.asmx
 106 /Build/v1.0/PublishTestResultsBuildService.asmx
 107
 108
 109 CodePlex Example Usage
 110 ===================================================================
 111 For registered developers, CodePlex is a publicly accessible example
 112 of a Team Foundation server used to host open source projects. Here's
 113 some examples of how to use the TF tool to access CodePlex hosted
 114 source code.
 115
 116 In the commands below,
 117
 118   UID = your codeplex user name
 119   PWD = your codeplex password
 120   MACHINENAME = your machine name (or any other random name)
 121
 122 Note:   "snd" is the domain name I got with my signon. Not sure
 123 if this is the same for everyone or not.
 124
 125 First create a workspace:
 126
 127   tf /server:https://tfs01.codeplex.com /login:snd\\UID,PWD
 128   workspace /new "MACHINENAME;UID"
 129
 130 Then map "Turtle" project to a local folder:
 131
 132   tf /server:https://tfs01.codeplex.com /login:snd\\UID,PWD
 133   workfold "$/Turtle" ~/Source/turtle
 134
 135 Then pull the files:
 136
 137   tf /server:https://tfs01.codeplex.com /login:snd\\UID,PWD get
 138   ~/Source/turtle /recursive
 139
 140 Now, to edit the "License.txt" file:
 141
 142   cd ~/Source/turtle
 143   tf edit License.txt
 144
 145 This makes the file writable. To see what you have checked out:
 146
 147   tf status
 148
 149 To check License.txt back in:
 150
 151         tf checkin /comment:"My comment" License.txt
 152
 153 This makes the file read-only again. You don't have to specify
 154 License.txt. If you don't specify a filename or filenames, it checks
 155 in everything you have checked out.
 156
 157 Then you could review the history, review a changeset, then look
 158 at the diff of the changeset. Note: the examples below assume
 159 Credentials.Save is on.
 160
 161   cd ~/Source/turtle
 162   tf history /recursive .
 163   tf changeset 340
 164   tf diff C340
 165
 166
 167 Code Samples
 168 -----------------------------------------------------------------
 169 Buck Hodges has written numerous examples of using the TFS API.
 170 You can find a list of these samples here:
 171
 172 http://blogs.msdn.com/buckh/archive/2006/08/12/tfs_api_links.aspx
 173
 174 The following examples have been compiled and tested against
 175 TF for Mono:
 176
 177 http://blogs.msdn.com/buckh/archive/2005/10/26/485458.aspx
 178 http://blogs.msdn.com/buckh/archive/2006/04/06/project_diff.aspx (with 2 changes)
 179
 180
 181 Links of Interest
 182 -----------------------------------------------------------------
 183
 184 http://msdn2.microsoft.com/en-us/library/bb130146(VS.80).aspx
 185 http://msdn2.microsoft.com/en-us/teamsystem/default.aspx
 186 http://msdn2.microsoft.com/en-us/cc31bk2e(VS.80).aspx
 187
 188
 189 Mailing List / Discussion Group
 190 -----------------------------------------------------------------
 191 http://groups.google.com/group/tf4mono
 192
 193 Members may post messages to: tf4mono@googlegroups.com