This post was originally published here.
In part 1 and 2 of this series, I gave an overview of Team Foundation Build and discussed installation and configuration options. One thing I should note is that if a team needs to add custom tasks to the build that are in separate assemblies, these assemblies need to be copied to the build machine. That implies that the dev team probably needs administrator access to the build machine.
In VSTS, build definitions are called Build Types, and are created through the Team Explorer. Creating a Build Type is accomplished through a wizard, which will walk you through the steps of defining the build. So what does Team Build provide out of the box? Namely, what are the build steps involved? First, Team Build will:
- Synchronize with source control
- Compile the application
- Run unit tests
- Perform code analysis
- Release builds on a file server
- Publish build reports
So out of the box, we don’t have to worry about configuring source control, compiling, and other common tasks that we would otherwise need to define ourselves. When I launch the New Team Build Type Creation Wizard from Team Explorer, the wizard walks me through the following steps:
- Create a new build type
- Select the solutions to build
- Select a configuration and platforms for build
- Select a build machine and drop location
- Select build options
I’ll walk through each of these steps one by one.
Step 1: Create a new build type
In the first screen, you need to specify the name of your Build Type. Unfortunately, all Build Types are grouped in one folder in source control, so we have to use names instead of folders to distinguish different builds. Naming conventions can help that situation, so something like <Application>_<Version>_<Region>_<BuildType> would work. In the past, I’ve defined several builds for the same application, like “Deploy”, “Nightly”, “CI”, etc. Build Type names can be a pain to change, so choose your Build Type names carefully.
Step 2: Select the solutions to build
Build Type definitions allow you to select one or more Visual Studio solutions to build. In most cases, you would have only one solution to build, but if there are more than one solution to build, you can select multiple and specify the order that each solution will be compiled. If SolutionA depends on SolutionB, just have SolutionB build before SolutionA.
Step 3: Select a configuration and platforms for build
In this screen, you can specify the project configuration you would like to build with. Typically this could be “DEBUG”, “RELEASE”, or any custom project configurations you might have. Typically, I might have a separate project configuration like “AUTOMATEDDEBUG” that might add code analysis. I usually leave the platform to “Any CPU”, but if you have specific platform requirements, this is where you would specify that.
Step 4: Select a build machine and drop location
When specifying the build machine, Team Build needs two pieces of information:
- What is the name of the build machine?
- What directory on the build machine should I build in?
The build machine is the machine that has Team Build Service installed on it. The directory can be anything, but keep in mind that you don’t necessarily want all builds being built in the same directory. Team Build is good about separating builds in the file system, but I’ve had hard drives fill up when I had too many builds going on the same machine
The other piece of information in this step is the drop location. When Team Build finishes compiling and testing, it will copy the files to a UNC share you specify here. Don’t worry, if you need additional files dropped, you can customize this later in the Build Type definition.
Step 5: Select build options
This step is entirely optional (but strongly recommended). You can specify that you would like this build to run tests and perform code analysis. If you select “Run test”, you will need to specify the test metadata file (*.vsmdi) and the test list to run. In my last project, we had over 1300 unit tests when I left, which was absolutely impossible to manage in a test list. We used custom task to specify our tests to run, which would use reflection to load the tests dynamically.
The other option available is code analysis, which is important for enforcing coding guidelines and standards. Without code analysis turned on, you’ll probably have a different coding standard for every developer who touched the code.
Step 6: Finish
When you complete the wizard, two new files are created in source control:
- TfsBuild.proj – this is the Build Type definition, where you’d put any customization
- WorkspaceMapping.xml – definition of the source control workspace, where you can change the build directory
You can find these files in the source control explorer in $/[Team Project]/TeamBuildType/[Build type name]. Manually going through source control is a little bit of a pain if I want to edit the TfsBuild.proj file, so I use Attrice’s Team Foundation Sidekick add-in, which lets my right-click and check out and check in directly from Team Explorer.
So that’s it! To start a new build just right-click the Build Type in Team Explorer and select “Build”. Double-clicking the Build Type will bring up a list of all of the builds with their statuses. This is also where you can view the details of an individual build.
In the next posts, I’ll detail some values, principles, and practices when it comes to automated builds, as well as some discussion on customizing and extending a Build Type definition.