https://github.com/microsoft/MSBuildSdks

MSBuild project SDKs
https://github.com/microsoft/MSBuildSdks

msbuild

Last synced: about 2 months ago
JSON representation

MSBuild project SDKs

• Host: GitHub
• URL: https://github.com/microsoft/MSBuildSdks
• Owner: microsoft
• License: mit
• Created: 2018-01-30T16:49:11.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-06-27T07:25:13.000Z (3 months ago)
• Last Synced: 2024-06-28T12:34:49.246Z (3 months ago)
• Topics: msbuild
• Language: C#
• Homepage:
• Size: 1.09 MB
• Stars: 434
• Watchers: 27
• Forks: 80
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# MSBuild SDKs

[![Build Status](https://dev.azure.com/devdiv/DevDiv/_apis/build/status/MSBuild/microsoft.MSBuildSdks%20Official?branchName=main)](https://dev.azure.com/devdiv/DevDiv/_build/latest?definitionId=13584&branchName=main)

The MSBuild project SDKs are used to configure and extend your build.

## What SDKs are available?

### [Microsoft.Build.Traversal](src/Traversal)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Build.Traversal.svg)](https://www.nuget.org/packages/Microsoft.Build.Traversal)

 [![NuGet](https://img.shields.io/nuget/dt/Microsoft.Build.Traversal.svg)](https://www.nuget.org/packages/Microsoft.Build.Traversal)

Supports creating traversal projects which are MSBuild projects that indicate what projects to include when building your tree.  For large project trees, they are replacements for Visual Studio solution files.

### [Microsoft.Build.NoTargets](src/NoTargets)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Build.NoTargets.svg)](https://www.nuget.org/packages/Microsoft.Build.NoTargets)

 [![NuGet](https://img.shields.io/nuget/dt/Microsoft.Build.NoTargets.svg)](https://www.nuget.org/packages/Microsoft.Build.NoTargets)

Supports utility projects that do not compile an assembly.

### [Microsoft.Build.Artifacts](src/Artifacts)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Build.Artifacts.svg)](https://www.nuget.org/packages/Microsoft.Build.Artifacts)

 [![NuGet](https://img.shields.io/nuget/dt/Microsoft.Build.Artifacts.svg)](https://www.nuget.org/packages/Microsoft.Build.Artifacts)

Supports staging artifacts from build outputs.

### [Microsoft.Build.CopyOnWrite](src/CopyOnWrite)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Build.CopyOnWrite.svg)](https://www.nuget.org/packages/Microsoft.Build.CopyOnWrite)

 [![NuGet](https://img.shields.io/nuget/dt/Microsoft.Build.CopyOnWrite.svg)](https://www.nuget.org/packages/Microsoft.Build.CopyOnWrite)

Enables Copy on Write for faster file copies.

### [Microsoft.Build.RunVSTest](src/RunTests)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Build.RunVSTest.svg)](https://www.nuget.org/packages/Microsoft.Build.RunVSTest)

 [![NuGet](https://img.shields.io/nuget/dt/Microsoft.Build.RunVSTest.svg)](https://www.nuget.org/packages/Microsoft.Build.RunVSTest)

Hooks VSTest to the Test target, allowing running tests concurrently with the build via `msbuild /t:Build;Test`.

## How can I use these SDKs?

When using an MSBuild Project SDK obtained via NuGet (such as the SDKs in this repo) a specific version **must** be specified.

Either append the version to the package name:

```xml

  ...

```

Or omit the version from the SDK attribute and specify it in the version in `global.json`, which can be useful to synchronise versions across multiple projects in a solution:

```json

{

  "msbuild-sdks": {

    "Microsoft.Build.Traversal" : "2.0.12"

  }

}

```

Since MSBuild 15.6, SDKs are downloaded as NuGet packages automatically. Earlier versions of MSBuild 15 required SDKs to be installed. 

For more information, [read the documentation](https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk).

## What are MSBuild SDKS?

MSBuild 15.0 introduced new project XML for .NET Core that we refer to as SDK-style.  These SDK-style projects looks like:

```xml

  

    net46

  

```

At evaluation time, MSBuild adds implicit imports at the top and bottom of the project like this:

```xml

  

  

    net46

  

  

```

# Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions

provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.