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

The final XML element we'll cover on this tour is Import, and it's the key to making your build process reuseable. It pulls in another MSBuild file. Right at the bottom of your Visual Basic and C# files, you'll see an Import tag that pulls in the "Microsoft. CSharp.targets" or "Microsoft.VisualBasic.targets" file, which is the root of the build process for these projects. Both targets files again import the "Microsoft.Common.targets" file. There's more to MSBuild syntax, which is covered in the online documentation, but this overview should give you an idea.

Traditionally build processes log to the console and to log files. The information logged is fairly hard-coded: the folder that's currently building, the command lines executing, and their output, including any warnings and errors. MSBuild was designed to log in a much richer fashion. Strongly typed .NET events are fired at each step, and any number of "loggers" can subscribe to the events they want and do whatever they like with the information. Events include "ProjectStarted" and "Message", which can be emitted by a <Message> task in the build. Output from tools the build launches is logged as Message, Error or Warning events as appropriate.

The build process is abstracted from the loggers, which are chosen when the build starts. For example, a builder might simultaneously attach a console logger, several file loggers with different verbosity settings, and a logger that inserts event details in a database. MSBuild ships with a built-in console logger, which is attached by default, and a file logger, both of which have adjustable verbosity settings. Like tasks, loggers are just .NET classes and you can write your own - start by deriving from the Logger class.

How MSBuild Builds a Project
MSBuild can be invoked directly on the command line (msbuild.exe) or inside Visual Studio. Either way the build is handled by the same MSBuild engine. Here's what MSBuild does:

1.  First, any global properties are applied to the project. Global properties are special: they can't be modified except within a Target. If MSBuild is invoked from the command line, the set of global properties will be the ones passed in via the /property: command line switch. If MSBuild is invoked as part of Visual Studio, the active configuration and platform are the global properties.
2.  Starting from the beginning of the project file, MSBuild engine evaluates the properties that are defined in the project. Imported targets files are loaded and evaluated as the MSBuild engine progresses: think of them as inserted directly into the project file. If a property is defined in two or more places, the last one wins.
3.  After the properties are evaluated, MSBuild engine evaluates all the item definitions that are defined then makes a third pass to evaluate items. At every step of the evaluation, all previously evaluated property values and item values an be used.
4.  MSBuild starts to execute the entry-point targets. These targets can be specifi ed via the /target: command line switch or the default targets defi ned in the project file through the project element's DefaultTargets attribute, or else MSBuild just picks the first target Visual Studio's entry points are fixed: Build, Clean, Rebuild, or Publish.

If the condition on a target is true, MSBuild will make sure all its dependencies are executed then execute the target itself, invoking the tasks in it one by one.
5.  By using the special "MSBuild" task, a project can cause another project to build. If a project references the outputs of another, it will use the MSBuild task to make sure that project is up-todate. Once the referenced project is done building, the MSBuild engine will resume building the referencing project.

To see what's happening in the build, specify the "detailed" or "diagnostic" verbosity level. To do this from the command line, use the /verbosity: switch to toggle the amount of information displayed during the build. In Visual Studio, this can be customized in the Tools/Options menu. On the "Build and Run" node under "Project and Solutions" from the left pane, you'll see a dropdown for "MSBuild project build output verbosity."

MSBuild can divide item lists into different "batches" using their metadata then execute each batch one at a time. This can be confusing, but once you get used to the idea it feels natural - and powerful.

Here's an example that creates a different folder for each value of the "Culture" metadata on an item list. You'll see that the Culture metadata, referenced with the special metadata ‘%' syntax, is passed into the task: that tells MSBuild to run the task once for each unique Culture value. In this example, the task runs twice.

    <Resource Include="Form1.en-CA.resx;Form2.en-CA.resx">
    <Resource Include="Form1.en-NZ.resx">

<Target Name="CreateCultureDirs">
        <MakeDir  Directories="%(Resource.Culture)"/>

Here's a trick that sometimes comes in handy: to execute a task once for each item, you can use the well-known item metadata Identity, which usually has a different value for each item.

Hosting the MSBuild Engine
If you like, you can host the MSBuild engine in your application, just as Visual Studio does. By referencing the Microsoft.Build.BuildEngine assembly, you can load, edit, and build projects. Perhaps you're writing a tool for analyzing a build tree, or even a product like Visual Studio that you want to read and write MSBuild format projects.

As we mentioned, not all Microsoft project types are in MSBuild format right now. In Visual Studio 2005, Visual C++ projects are in their own format, as are Visual Studio Deployment projects and ASP.NET Web site projects. Visual Studio solution fi les are still in their own format too. Of course, most of us have some of these projects, and we need to build them on the command line too.

MSBuild does its best to interoperate with them. MSBuild can read Visual Studio solution files by translating them internally into MSBuild format. When a Visual C++ project is encountered, MSBuild will try to build it with vcbuild.exe, which ships as part of Visual Studio and the .NET SDK. For ASP. NET Web site projects, MSBuild will launch a tool to pre-compile them. In both cases, MSBuild generally won't require Visual Studio installed to build them. Indeed Visual Studio Team System's Build Server feature is designed to use MSBuild to work on dedicated build machines that don't have the full Visual Studio product installed.

The interoperability isn't perfect. As you'd expect, the different formats can't work together exactly. We hope MSBuild handles them well enough for most people to get by until they are all based on MSBuild. If you don't get the results you need, the fallback is to have Visual Studio installed and build with Visual Studio's devenv.exe application on the command line.

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
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
SYS-CON Events announced today that Evatronix 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. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
An increasing number of companies are creating products that combine data with analytical capabilities. Running interactive queries on Big Data requires complex architectures to store and query data effectively, typically involving data streams, an choosing efficient file format/database and multiple independent systems that are tied together through custom-engineered pipelines. In his session at @BigDataExpo at @ThingsExpo, Tomer Levi, a senior software engineer at Intel’s Advanced Analytics gr...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things’). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing? IoT is not about the devices, it’s about the data consumed and generated. The devices are tools, mechanisms, conduits. In his session at Internet of Things at Cloud Expo | DXWor...