Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dotnet/msbuild

The Microsoft Build Engine (MSBuild) is the build platform for .NET and Visual Studio.
https://github.com/dotnet/msbuild

build hacktoberfest help-wanted microsoft msbuild visual-studio

Last synced: 7 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
# Microsoft.Build (MSBuild)



[![Build Status](https://dev.azure.com/dnceng-public/public/_apis/build/status/75?branchName=main&label=Public)](https://dev.azure.com/dnceng-public/public/_build?definitionId=75) [![Build Status](https://devdiv.visualstudio.com/DevDiv/_apis/build/status/9434?label=Internal&branchName=main)](https://devdiv.visualstudio.com/DevDiv/_build?definitionId=9434)



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](https://learn.microsoft.com/visualstudio/msbuild/msbuild) on learn.microsoft.com.



The [changelog](documentation/Changelog.md) has detailed information about changes made in different releases.



## Building



### Building MSBuild with Visual Studio 2022 on Windows



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



To get started on **Visual Studio 2022**:



1. [Install Visual Studio 2022](https://www.visualstudio.com/vs/).  Select the following Workloads:

   - .NET desktop development

   - .NET Core cross-platform development

2. Ensure [long path support](https://learn.microsoft.com/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later) is enabled at the Windows level.

3. Open a `Developer Command Prompt for VS 2022` prompt.

4. Clone the source code: `git clone https://github.com/dotnet/msbuild`

   - You may have to [download Git](https://git-scm.com/downloads) first.

5. 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.

6. Open `MSBuild.sln` or `MSBuild.Dev.slnf` in Visual Studio 2022.



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](documentation/wiki/Building-Testing-and-Debugging-on-.Net-Core-MSBuild.md)



## 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](documentation/wiki/Localization.md)



### 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](documentation/wiki/Contributing-Code.md)

* **Developer Guide on:**

   - [.NET Core](documentation/wiki/Building-Testing-and-Debugging-on-.Net-Core-MSBuild.md)

   - [Full Framework](documentation/wiki/Building-Testing-and-Debugging-on-Full-Framework-MSBuild.md)



* See our [help wanted issues](https://github.com/dotnet/msbuild/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) 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](documentation/wiki/Labels.md) 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](https://github.com/dotnet/msbuild/issues/new/choose)

* [Start a discussion](https://github.com/dotnet/msbuild/discussions)



### MSBuild Components



* **MSBuild**. [Microsoft.Build.CommandLine](https://docs.microsoft.com/visualstudio/msbuild/msbuild)  is the entrypoint for the Microsoft Build Engine (MSBuild.exe).



* **Microsoft.Build**. The [Microsoft.Build](https://docs.microsoft.com/dotnet/api/?term=Microsoft.Build) namespaces contain types that provide programmatic access to, and control of, the MSBuild engine.



* **Microsoft.Build.Framework**. The [Microsoft.Build.Framework](https://docs.microsoft.com/dotnet/api/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](documentation/wiki/Microsoft.Build.Framework.md).



* **Microsoft.Build.Tasks**. The [Microsoft.Build.Tasks](https://docs.microsoft.com/dotnet/api/microsoft.build.tasks) namespace contains the implementation of all tasks shipping with MSBuild.



* **Microsoft.Build.Utilities**. The [Microsoft.Build.Utilities](https://docs.microsoft.com/dotnet/api/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](LICENSE).