Rally Connector for Team Build Installation and Usage

Transcription

1 1. Introduction For developers and testers who use Microsoft Team Foundation Build or MS Build. The connector provides a simple method to display the results from the MS Build system in Rally and optionally create a defect when the build fails. The failing or passing build icon is highly visible to Rally users to promote the stop-the-line mentality where the first priority is to fix the failing build. 2. Software/Hardware Requirements The following are the hardware and software requirements to install and run the Rally Connector for. Windows XP or Windows 2003 Server Team Foundation Server 2005 or 2008 with if using Microsoft Team Foundation Build Microsoft Build Engine (MSBuild) with Visual Studio 2005 or 2008 Editor access to any Rally Project(s) where you want to post the results of MSBuild 3. Installation Basic Installation Steps 1. Install the Rally Connector for 2. Setup Default Configuration File 3. Setup Custom Configuration File(s) 3.1 New Installation 1. Right-click the RallyForMSBuild.msi file and click 'Install' from the pop-up menu. Alternatively, double-click the RallyForMSBuild.msi file and a 'Welcome Screen' is displayed. Click 'Next'. 2. A license agreement is displayed. The user needs to Accept this agreement to proceed. To accept this agreement, click I Agree and click the 'Next' button. Click 'Cancel' if you do not want to proceed with the installation. 3. Confirm the installation by clicking 'Next' to start the installation. 4. The connector will install in the Program Files directory by default. e.g. C:\Program Files\MSBuild\Rally MSBuild Plugin 3.2 Setup Default Configuration File

2 Navigate to the the installation directory for the connector (e.g C:\Program Files\MSBuild\Rally MSBuild Plugin). Open the MsBuildProperties.config configuration file in a text editor such as Wordpad and specify the following parameters: ServerName - trial.rallydev.com, rally1.rallydev.com or IP address (on-premise) Workspace - Name of Rally workspace ProjectName - Name of Rally project UserName - Rally login name (e.g. username@company.com) Password - Rally password for the username you specified CreateDefect - Set this to 'true' if you want a defect created when there is a failing build. Otherwise, set to 'false' to disable this feature. <! Values of following parameters would be used to update Rally build-status --> <? Xml version="1.0" encoding="utf-8?> <MsBuildProperties> <ServerName>rally1.rallydev.com</ServerName> <Workspace>Development 2008</Workspace> <ProjectName>Development Project</ProjectName> <UserName>username@company.com</UserName> <Password>password</Password> <CreateDefect>true</CreateDefect> </MsBuildProperties> The value of parameters in the MsBuildProperties.config file will be common for all projects that the user wants to build. 3.3 Setup Custom Configuration File(s) MSBuild with Visual Studio users: For any project/solution that is built using MSBuild that you want linked to a Rally Project, create a "<ProjectName>.rally" file in the same directory as the Visual Studio project/solution (see screenshot below). Team Foundation Build users: For any that the user wants linked to a Rally project, create a "TFSBuild.rally" file in the same directory as the TFSBuild.proj file. Refer to 'Section 4: Setup Team Foundation Build' for more details.

3 The "*.rally" file will contain specific Rally configurations and acts as a flag to update the Rally build object with build status of a MSBuild. If the "*.rally file is not found in the folder, the connector will stay inactive. This file will contain Rally specific configurations which the user might want to change from the common configuration specified in MsBuildProperties.config. If the project/solution maps to the same Rally properties specified in the default configuration file (MsBuildProperties.config created in Section 3.2), then this file only needs to have a name of "<ProjectName>.rally or 'TFSBuild.rally" (if using ) and can remain empty. If the user wishes to link the project/solution to a different Rally Workspace/Project then specified in the default configuration file (MsBuildProperties.config), then ONLY include the applicable tags in the configuration file. For example: <! Values of following parameters would be used to update Rally build-status --> <? Xml version="1.0" encoding="utf-8?> <MsBuildProperties> <Workspace>XYZ Development</Workspace> <ProjectName>Project 1></ProjectName> </MsBuildProperties> 4. Setup Team Foundation Build To use the connector with Team Foundation Builds, define a new team build type by using 'New Type' creation wizard. There is one definition file for each build type, and that file is named TFSBuild.proj. Setting up the build includes defining the build computer, the directory in which to build, the drop location, and the solutions to build. This file is stored in source control under the folder $\MyProject\TeamBuildTypes\BuildType, where MyProject is the name of the team project and BuildType is the name of the build

4 type. Rally Connector for To link a build to a Rally project, save the TFSBuild.rally configuration file in the same directory as TFSBuild.proj in source control as shown in the following screenshot: If TFSBuild.rally exists, then s will interact with Rally and the success/failure of a is reflected in Rally for the specific project. 5. Setting up the Build Label and Passing a Message to Rally The connector can receive extra messages from MSBuild or TFSBuild and will pass these on to the Build Label in Rally and the Defect Description. In general, to pass an extra message to Rally, you will want to add the following to your MSBuild.proj or TFSBuild.proj file: <Target Name="AfterDropBuild"> <Message Text="RallyMessage:The Message" Importance="high"/> </Target> By adding the keyword RallyMessage, the connector will pick up the string after the colon and add that to the defect description. You can set the Rally Build Label that appears on the failed or success notice with the following setup: <Target Name="AfterDropBuild"> <Message Text="RallyMessage:RallyBuildLabel-$(BuildNumber)" Importance="high"/> </Target> 6. Troubleshooting

5 For general troubleshooting, take a look at the standard log for the build. The updating of Rally should be logged along with any errors that may have occurred. 7. Frequently Asked Questions 8. Contacting Technical Support Please submit a Rally Support case from Rally by navigating to Help & Training and click the Contact Support tab or visit