|Developer(s)||Microsoft, .NET Foundation|
v17.3.0 / 14 July 2022
|Platform||.NET Framework, .NET|
Microsoft Build Engine, or MSBuild, is a set of free and open-source build tools for managed code under the Common Language Infrastructure as well as native C and C++ code. It was first released in 2003 and was a part of .NET Framework. MSBuild is included with Visual Studio, but can also be run independently through MSBuild's command-line interface.
MSBuild is a build tool that helps automate the process of creating a software product, including compiling the source code, packaging, testing, deployment and creating documentations. With MSBuild, it is possible to build Visual Studio projects and solutions without the Visual Studio IDE installed. MSBuild is free and open-source. MSBuild was previously bundled with .NET Framework; starting with Visual Studio 2013, however, it is bundled with Visual Studio instead. MSBuild is a functional replacement for the nmake utility, which remains in use in projects that originated in older Visual Studio releases.
MSBuild acts on MSBuild project files which have a similar XML syntax to Apache Ant or NAnt. Even though the syntax is based upon well-defined XML schema, the fundamental structure and operation is comparable to the traditional Unix make utility: the user specifies what will be used (typically source code files) and what the result should be (typically a static library, DLL or an executable application), but the utility itself decides what to do and the order in which to carry out the build.
MSBuild can build a project against a supported .NET Framework version of choice. This feature is called "multitargeting". Any given build of a project, however, can only target one version of the framework at a time.
MSBuild was first created in 2003 targeting .NET Framework 2.0 for use in Visual Studio 2005 (codenamed Whidbey) and Windows Vista (codenamed Longhorn).
|Version||.NET Framework||Visual Studio Version||Usual Install Locations (x86)|
|12.0||4.5.2||2013||C:\Program Files (x86)\MSBuild\12.0\Bin|
|14.0||4.6||2015||C:\Program Files (x86)\MSBuild\14.0\Bin|
This section may be confusing or unclear to readers. In particular, it is unclear what this section is talking about and what is the nature of, say, a "Target" or "Task". Examples would help. (April 2013)
- A Target contains a set of tasks for MSBuild to execute. The focus of MSBuild is the result Target specified when invoking MSBuild with the project file. This is because a Project may contain several Target entries, each executed sequentially (and conditionally). Subsequent dependent Targets are executed before the requested Target. The execution flow of the current Target can be directed using the following attributes: Condition, BeforeTargets, AfterTargets, & DependsOnTargets. Each Target may be self-contained with the necessary Tasks to complete itself. A Target is typically an action executed on a file, set of files or directory.
- A Task is a command which is executed in order to complete a Target. Tasks are used to group and execute any number of actions during the build process. They are typically implemented in a .NET assembly as a class which inherits from the Task class or implements the ITask interface. Many basic tasks are shipped as part of the .NET Framework, and community developed tasks are freely available. Some examples of Tasks include copying files, creating directories, or parsing XML.
- Properties and Items
- MSBuild provides Properties and Items, which are conceptually equivalent to make's macros. Properties specify static values, whereas Items are usually used to define sets of files or folders on which to perform Tasks. Specifying files on Items is made easy by the support of wildcards.
- ^ "Latest release". Microsoft/msbuild. GitHub. Microsoft. Retrieved 2022-08-20.
- ^ "microsoft/msbuild: The Microsoft Build Engine (MSBuild) is the build platform for .NET and Visual Studio". GitHub. Microsoft. Retrieved 2019-07-23.
- ^ Hashimi, Sayed Ibrahim; Bartholomew, William (2009). Inside the Microsoft Build Engine: Using MSBuild and Team Foundation Build. Microsoft Press. p. 406. ISBN 978-0-7356-2628-7.
- ^ "MSBuild". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ Lander, Rich (18 March 2015). "MSBuild Engine is now Open Source on GitHub". .NET Blog. MSDN Blogs. Microsoft. Retrieved 2019-07-23.
- ^ a b "What's new in MSBuild 12.0". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ "MSBuild multitargeting overview". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ "Building, Testing, and Deployment". What's New in Visual Studio 2005. MSDN. Microsoft. Archived from the original on 2014-08-26.
- ^ Sneath, Tim (July 19, 2004). "MSBuild: The New Build System for Visual Studio 2005 and Longhorn". Tim Sneath. MSDN Blogs. Retrieved 2018-04-22.
- ^ England, Chuck (February 25, 2010). "Getting Started with MSBuild". The Visual Studio Blog. MSDN Blogs. Retrieved 2018-04-22.
- ^ "Standard and custom Toolset configurations". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ "What's new in MSBuild 15". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ "What's new in MSBuild 16.0". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- ^ "MSBuild task reference". MSBuild. Microsoft Docs. Retrieved 2019-07-23.
- Kretzler, Brian (2011). MSBuild Trickery: 99 Ways to Bend the Build Engine to Your Will. K Cross Seven Ranch Company. p. 426. ISBN 978-0-615-50907-5.
- Hashimi, Sayed Ibrahim (June 2006). "Inside MSBuild: Compiling Apps With Custom Tasks For The Microsoft Build Engine". MSDN Magazine. Microsoft. Archived from the original on 11 April 2015. Retrieved 11 April 2013.
- Hashimi, Sayed Ibrahim (March 2007). "WiX Tricks: Automate Releases With MSBuild And Windows Installer XML". MSDN Magazine. Microsoft. Retrieved 11 April 2013.
- Hashimi, Sayed Ibrahim (February 2009). "MSBuild: Best Practices For Creating Reliable Builds, Part 1". MSDN Magazine. Microsoft. Retrieved 11 April 2013.
- Hashimi, Sayed Ibrahim (March 2009). "MSBuild: Best Practices For Creating Reliable Builds, Part 2". MSDN Magazine. Microsoft. Retrieved 11 April 2013.
- Reif, Andreas (10 June 2010). "Einführung in Microsofts Build-Management-Technik MSBuild" [Introduction to Microsoft's build management technology, MSBuild]. heise Developer (in German). Heinz Heise. Retrieved 11 April 2013.
- Jones, Mike; Warren, Genevieve; Blome, Mike; Robertson, Colin; Hogenson, Gordon; Cai, Saisang (4 November 2016). "MSBuild target framework and target platform". MSBuild. Microsoft Docs. Retrieved 2018-02-19.