MSBuild Unveiled Peter Schneider MVP Visual Developer – Visual C# MCT, MCSD.NET, MCAD.NET, MCDBA

In This Session… MSBuild Architecture MSBuild Architecture MSBuild – File Format MSBuild – File Format MSBuild – Tips & Tricks MSBuild – Tips & Tricks

Authors PROJECT FILE - $%#^$&% Abracadabra Feeds Visual Studio.NET 2002/2003 VS Build System Produces Final Product Pre build step Post build step

Final Product Produces Feeds Authors DEVELOPER Authors MSBuild Design Goals MSBuild MSBuild PROJECT FILE

MSBuild in 5 minutes The underlying build engine in Visual Studio 2005 The underlying build engine in Visual Studio 2005 Fully open and published XML file format for describing build Fully open and published XML file format for describing build Visual Studio 2005 build is fully customizable Visual Studio 2005 build is fully customizable You extend the build by writing managed code (tasks and loggers) You extend the build by writing managed code (tasks and loggers) You don’t need the IDE to build Visual Studio projects You don’t need the IDE to build Visual Studio projects

MSBuild File Format MyCoolApp true $(AppName).exe <Csc EmitDebugInformation=“$(DebugSymbols)” OutputAssembly=“$(OutputAssembly)”/>

MSBuild Key Components Items Items Properties Properties Targets Targets Tasks Tasks

Build Items Represent Input to the build system Represent Input to the build system Grouped into Item Collections Grouped into Item Collections  Use userdefined CollectionNames Are used as Parameters for Tasks Are used as Parameters for Tasks Use Include and Exclude Attributes, Wildcards (**,*,?) Use Include and Exclude Attributes, Wildcards (**,*,?)

Build Items Reference ItemGroups Example: Reference ItemGroups Example:

Build Item Metadata Items may contain MetaData Items may contain MetaData 1 2 Used for batching Used for batching

Well Known Item Meta Data %(FullPath)%(RootDir)%(Filename)%(Extension)%(RelativeDir)%(Directory) %(RecursiveDir) %(Identity) %(ModifiedTime) %(CreationTime) %(AccessedTime) <Copy DestinationFiles=“%(Compile.Filename).bak” />

Build Properties Properties are key/value pairs used to configure builds Properties are key/value pairs used to configure builds Defined in PropertyGroups Defined in PropertyGroups Debug Reference Properties with $(Propertyname) e.g. $(Configuration) Reference Properties with $(Propertyname) e.g. $(Configuration)

Reserved Properties  MSBuildProjectDirectory  MSBuildProjectFile  MSBuildProjectExtension  MSBuildProjectFullPath  MSBuildProjectName  MSBuildBinPath  MSBuildProjectDefaultTargets  MSBuildExtensionsPath Some PropertyNames are reserved: Some PropertyNames are reserved: Environment Variables are accessible as Properties Environment Variables are accessible as Properties

Setting Properties You can set Properties from the commandline You can set Properties from the commandline MSBuild.exe MyProject.proj /p:Configuration=Debug MSBuild.exe MyProject.proj /p:Configuration=Debug;Another=Test You can set Properties depending on other properties You can set Properties depending on other properties full

Build Targets Targets group tasks together in a particular order Targets group tasks together in a particular order Allows sections of the build process to be called individually (Commandline, CallTarget Task) Allows sections of the build process to be called individually (Commandline, CallTarget Task) MSBuild.exe MyProject.proj /t:Compile MSBuild.exe MyProject.proj /t:Clean;Compile

Default Targets Use DefaultTargets Attribute Use DefaultTargets Attribute... InitialTargets are executed first InitialTargets are executed first...

Incremental Builds Reduce build time Reduce build time Only builds targets which are out-of- date or not yet built Only builds targets which are out-of- date or not yet built Specify Inputs and Outputs of the target Specify Inputs and Outputs of the target <Target Name=“Compile” Inputs = Outputs = “HelloWorld.exe” >

Build Tasks A Task is a unit of executable code which performs atomic build operations A Task is a unit of executable code which performs atomic build operations

Build Task Outputs Task can return Output mapped to Items or Properties Task can return Output mapped to Items or Properties

Build Task ContinueOnError Specify the ContinueOnError Attribute to succeed target for non-critical tasks Specify the ContinueOnError Attribute to succeed target for non-critical tasks Other possibilities: Other possibilities:

Project Elements Use Choose, When, Otherwise Elements Use Choose, When, Otherwise Elements Test

Summary Properties Properties Items Items Targets Targets Tasks Tasks Projects Projects