aptivi-archives/msbuild

The Microsoft Build Engine (MSBuild) is the build platform for .NET and Visual Studio.

Microsoft.Build (MSBuild)

The Microsoft Build Engine is a platform for building applications. This engine, also known as MSBuild, provides an XML schema for a project file that controls how the build platform processes and builds software. Visual Studio uses MSBuild, but MSBuild can run without Visual Studio. By invoking msbuild.exe on your project or solution file, you can orchestrate and build products in environments where Visual Studio isn't installed.

For more information on MSBuild, see the MSBuild documentation on docs.microsoft.com.

The changelog has detailed information about changes made in different releases.

Build Status

The current development branch is main. Changes in main will go into a future update of MSBuild, which will release with Visual Studio 17.0 and a corresponding version of the .NET Core SDK.

We have forked for MSBuild 16.11 in the branch vs16.11. Changes to that branch need special approval.

MSBuild 16.9 builds from the branch vs16.9. Only high-priority bugfixes will be considered for servicing 16.9.

MSBuild 16.7 builds from the branch vs16.7. Only high-priority bugfixes will be considered for servicing 16.7.

MSBuild 16.4 builds from the branch vs16.4. Only high-priority bugfixes will be considered for servicing 16.4.

MSBuild 15.9 builds from the branch vs15.9. Only very-high-priority bugfixes will be considered for servicing 15.9.

Building

Building MSBuild with Visual Studio 2019 on Windows

For the full supported experience, you will need to have Visual Studio 2019 or higher.

To get started on Visual Studio 2019:

1. Install Visual Studio 2019. Select the following Workloads:

• .NET desktop development
• .NET Core cross-platform development

2. Open a Developer Command Prompt for VS 2019 prompt.
3. Clone the source code: git clone https://github.com/dotnet/msbuild

• You may have to download Git first.

4. Run .\build.cmd from the root of the repo to build the code. This also restores packages needed to open the projects in Visual Studio.
5. Open MSBuild.sln or MSBuild.Dev.slnf in Visual Studio 2019.

Note: To create a usable MSBuild with your changes, run .\build.cmd /p:CreateBootstrap=true. To build release, add -c Release: .\build.cmd -c Release /p:CreateBootstrap=true.

This newly-built MSBuild will be located at artifacts\bin\bootstrap\net472\MSBuild\Current\Bin\MSBuild.exe. It may not work for all scenarios, including C++ builds.

Building MSBuild in Unix (Mac & Linux)

MSBuild can be run on Unix systems that support .NET Core. Set-up instructions can be viewed on the wiki: Building Testing and Debugging on .Net Core MSBuild

Localization

You can turn on localized builds via the /p:LocalizedBuild=true command line argument. For more information on localized builds and how to make contributions to MSBuild's translations, see our localization documentation

Interested in contributing?

Before you contribute, please read through the contributing and developer guides to get an idea of what kinds of pull requests we accept.

• Contributing Guide

• Developer Guide on:

  • .NET Core
  • Full Framework
  • Mono

• See our up for grabs issues for a list of issues we think are great to onboard new developers.

  • Note: Please leave a comment asking to be assigned the issue if you want to work on it.

• See our label documentation for descriptions of labels we use throughout the repo.

Other ways to contribute

We encourage any contributions you decide to make to the repo!

• File an issue
• Start a discussion

MSBuild Components

• MSBuild. Microsoft.Build.CommandLine is the entrypoint for the Microsoft Build Engine (MSBuild.exe).

• Microsoft.Build. The Microsoft.Build namespaces contain types that provide programmatic access to, and control of, the MSBuild engine.

• Microsoft.Build.Framework. The Microsoft.Build.Framework namespace contains the types that define how tasks and loggers interact with the MSBuild engine. For additional information on this component, see our Microsoft.Build.Framework wiki page.

• Microsoft.Build.Tasks. The Microsoft.Build.Tasks namespace contains the implementation of all tasks shipping with MSBuild.

• Microsoft.Build.Utilities. The Microsoft.Build.Utilities namespace provides helper classes that you can use to create your own MSBuild loggers and tasks.

License

MSBuild is licensed under the MIT license.