Welcome!

Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

MSBuild - What It Does and What You Can Expect in the Future

The standard customizable build platform for the .NET Framework

In Visual Studio 2003 and earlier, the build process for Visual Basic and C# projects was hard-coded, and built into Visual Studio itself. The only build scripting tool that Microsoft offered was nmake, and a companion tool called build.exe that provided some support for concurrent builds. Visual Studio users whose build systems were based on makefiles had to maintain project files in parallel. For Visual Studio 2005, we thought it would be great if it was possible to completely customize the build process, and to build Visual Studio projects on machines that didn't even have Visual Studio installed, exactly the same as they built inside Visual Studio. We also wanted to be able to plug in reuseable build loggers and build steps.

MSBuild shipped in .NET Framework 2.0, and Visual Studio 2005 was based on it. To date we've only released build processes for Visual Basic and C#, but our vision is to make this truly the common build platform for Microsoft technologies. It's fair to say that internal Microsoft needs have motivated MSBuild almost as much as the needs of our customers. We're making exciting progress towards this goal, and we'll talk about our future plans later in this article.

MSBuild File Format
If you use Visual Studio 2005, you don't necessarily have to know anything about MSBuild syntax. Visual Studio's Visual Basic and C# project files are MSBuild format, and you can go right ahead and build them on machines without Visual Studio installed.

However if you want to customize the build process or create your own from scratch, you'll need to know something about the MSBuild syntax. We tried to make the file format as simple as possible, so it's easy to learn. It's XML, so any XML tool can work with it, and there are only a few different tags to know about. Let's do a quick tour.

PROPERTIES
MSBuild properties represent key/value pairs used during the build process. A property can only take one value at a time. Properties are always inside a PropertyGroup tag. If you open a Visual Basic or C# project file you'll see it uses properties to store whether the compiler should build with optimizations (the "Optimize" property), the output path (the "OutputPath" property), and what warning level it should use (the WarningLevelproperty). Think of properties as scalars. You can get their values with an expression like "$(PropertyName)".

ITEMS
MSBuild Item lists are just ordered bags, like arrays. An item list contains multiple MSBuild items of the same type. Each has a value and optional metadata. The syntax to access their values is different than properties: "@(ItemType)." The items in an item list are often file paths, but don't have to be - MSBuild doesn't care. Take a look at a Visual Basic or C# project again and you'll see items used to store all the source files (the "Compile" items) and references (the "Reference" items) in your project. They don't have to be hard-coded though. You can have MSBuild generate a list of items using wildcards such as "*.txt".

Like properties, items have an ItemGroup tag they always sit inside. Unlike properties, items can have arbitrary "metadata" attached to each one, which you can define with sub-elements below the item's element. Here's an example of metadata used to represent a Culture value on a resource item:

<ItemGroup>
   <Resource Include="Form1.en-CA.resx ">
     <Culture>en-CA</Culture>
   </Resource>
</ItemGroup>

Metadata is accessed with yet another kind of expression that looks like this "%(MetadataName)" or "%(ItemType.MetadataName)". There's also a variety of built-in metadata such as "Filename" and "Full-Path", which are useful if the item represents a file.

One item list can be converted to another by a transform operation. For example, if you write "@(Compile -> ‘%(Filename).obj'") you'll get the collection of "Compile" items, but the extension of each item will be changed to "obj". That can be useful for specifying the outputs of a target or constructing a command line string.

TARGETS
Targets are the unit of build: it's not possible to build only part of a target. This time open up your Microsoft.CSharp.targets file, which you'll find in the .NET Framework install folder, e.g., Windows\ Microsoft.NET\Framework\v2.0.50727. (By convention, targets are stored in files that have the ‘.targets' extension.) Now look for the ‘Target' tag. A target groups a collection of tasks together in a particular order to form a unit of build. For example, the "CoreCompile" target contains the "CSC" task that will invoke the C# compiler. Like every other MSBuild tag, Target tags can have conditions on them, but you can also add Input and Output attributes, which MSBuild will compare to see if the target is up-to-date already: if the target is up-todate, MSBuild will skip the tasks within it in part or entirely. A "DependsOnTargets" attribute lets you define what targets need to run beforehand so you can organize the order in which targets run. Targets can override previous targets with the same name. Targets have some other powers: partial incremental build and target batching; you can find out more about these on MSDN.

TASKS
Tasks are reuseable build actions that define the steps in a target. Tasks are always inside a target. Each task is implemented as a .NET class, and the parameters to a task - where you pass in the items and properties it needs - are just the .NET properties on that task. MSBuild comes with a set of built-in tasks like Delete, Message, GenerateResource (which is much like resgen.exe), plus tasks for the Visual Basic and C# compilers. There's also a special MSBuild task that runs MSBuild on another project. If those aren't enough, you can write your own - start by deriving from Task or ToolTask. Use a "UsingTask" tag to help MSBuild to find the assembly that implements your task. Tasks can also emit items and properties back into the build using Output sub-elements for subsequent tasks and targets to consume.

CONDITIONS
Every element in MSBuild syntax can have a Condition attribute. These have simple syntax something like conditions in XSL: logical operators "and", "or". parentheses, and so on. You can also use Choose, When, and Otherwise elements to make decisions. Here are some examples, so you can see what they look like:

<Compile Include="MyFile.cs" Condition="'$(Confi guration)'=='debug'"/>

In this example, the item "MyFile.cs" will be created only when the project is building in the debug configuration.

<Target Name="CreateOutputDirectory" Condition="!Exists(‘$(OutputDir)')" />

In this example, the target CreateOutputDirectory and the targets it depends on will run only if the output directory doesn't exist.


More Stories By Xin Yan

Xin Yan has been a software design engineer at Microsoft for over 7 years. He works on Visual Studio developer tools platform team.

More Stories By Dan Moseley

Dan Moseley is a software developer on the MSBuild and Visual Studio Project team.

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Paul 11/28/07 04:17:42 PM EST

I enjoyed the article on MSBuild, well written, concise, and interesting. But I was most interested in reading about Batching. In that section, you refer to an example using the Culture metadata, but I don't see the example you're referring to. Am I missing something?

@ThingsExpo Stories
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
DevOps at Cloud Expo – being held June 5-7, 2018, at the Javits Center in New York, NY – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real results. Among the proven benefits,...
@DevOpsSummit at Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, is co-located with 22nd Cloud Expo | 1st DXWorld Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
SYS-CON Events announced today that T-Mobile exhibited at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on qua...
SYS-CON Events announced today that Cedexis will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Cedexis is the leader in data-driven enterprise global traffic management. Whether optimizing traffic through datacenters, clouds, CDNs, or any combination, Cedexis solutions drive quality and cost-effectiveness. For more information, please visit https://www.cedexis.com.
SYS-CON Events announced today that Google Cloud has been named “Keynote Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Companies come to Google Cloud to transform their businesses. Google Cloud’s comprehensive portfolio – from infrastructure to apps to devices – helps enterprises innovate faster, scale smarter, stay secure, and do more with data than ever before.
SYS-CON Events announced today that Vivint to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. As a leading smart home technology provider, Vivint offers home security, energy management, home automation, local cloud storage, and high-speed Internet solutions to more than one million customers throughout the United States and Canada. The end result is a smart home solution that sav...
SYS-CON Events announced today that Opsani will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Opsani is the leading provider of deployment automation systems for running and scaling traditional enterprise applications on container infrastructure.
SYS-CON Events announced today that Nirmata will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nirmata provides a comprehensive platform, for deploying, operating, and optimizing containerized applications across clouds, powered by Kubernetes. Nirmata empowers enterprise DevOps teams by fully automating the complex operations and management of application containers and its underlying ...
SYS-CON Events announced today that Opsani to exhibit at SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California. Opsani is creating the next generation of automated continuous deployment tools designed specifically for containers. How is continuous deployment different from continuous integration and continuous delivery? CI/CD tools provide build and test. Continuous Deployment is the means by which...