Help documentation

 

TFS Material configuration

You can use TFS SCM as a material for your pipeline. The Go server and agents will use a TFS command line client to access your TFS server. The command line client will need to be installed on the server and agents.

  • Using Microsoft Visual Studio TFS Client
    • If you have visual studio on the Go server and agent, the default TFS command line client will typically be installed at 'Visual Studio Installtion/Common7/IDE/TF.exe'
    • Set a system environment variable TF_VS_HOME to the location of the TFS client. example: C:\Program Files\Microsoft Visual Studio 11.0\Common7\IDE\
    • Restart the Go server and agents.
  • Using Team Explorer Command Line Client
    • Install Team explorer cross platform command line client, TEE-CLC on the Go server and each agent that will use the TFS repository. This client can be used if your server or agents are on Linux.
    • Set a system environment variable TF_CLC_HOME to the installation path of the TEE-CLC tool. example: /var/tfs/tfs-tool. On linux you can add the environment variable to /etc/default/go-server and /etc/default/go-agent. On Windows you can add it as a system environment variable. On the Mac you can add the environment variable to /etc/launchd.conf.
    • Restart the Go server and agents.

You will need to configure the following to add a TFS material:

  • Material Name: An optional name for the material. This name can be used to set the TFS revision in the pipeline label.
  • URL: Set the url for the TFS collection. Ex: http://41.42.43.44:8080/tfs/DefaultCollection
  • Username: Provide the username in DOMAIN\username format. The user has to be a collection administrator for the TFS collection used in URL. Ex: THOUGHTWORKS\jim where THOUGHTWORKS is the domain name for the TFS account jim.
  • Password: Provide the password for the TFS account
  • Project Path: Enter the project path within the collection. You can specify paths of sub folders to create materials for each component. Ex: $/test/component or $/my_application
  • Check connection: You can use check connection to verify the TFS material configuration

Notes:

  • Go will map TFS projects to destination folders within the Go server and agent instalaltion directories. You can identify mappings by looking at the destination folders.
  • In this release, Go does not delete any workspace it has created. Workspace names are generated internally.
  • If possible, create a new user account on TFS which will be used for creating TFS materials in Go. You can use this account to easily identify TFS workspaces that Go created on the server and agents.
  • If you are using the cross platform command line client, you cannot run the Go server and Go agent as a service on the local system account. You will need to run the service with a user account which has accepted the eula for the client.
  • If at any point, you need to change the go server installation to a different location or machine, you will need to manually delete the old tfs mappings at the old Go server location.