msbuild/documentation

Welcome to MSBuild docs!

The folder contains collection of docs and references for MSBuild, detailed information on how to work with this repo, and covers in-depth technical topics related to implementation.

Getting Started

• What is MSBuild?

• Building Testing and Debugging

  • Full Framework MSBuild
  • .Net Core MSBuild
  • macOS

• MSBuild resources

• MSBuild tips & tricks

NuGet packages

• General information

Release information

• Changelog
• Release process
• Change waves
• Interactions with the internal repository

Development and contributing

• Providing binary logs for investigation
• Contributing code
  • Contributing tasks
• Error codes
• Deploying built MSBuild
• Events emitted by MSBuild
• Change waves (for developers)
• GitHub labels
• Localization

Problems?

• Rebuilding when nothing changed
• Controling References Behavior
• Something's wrong in my build
• Some gotchas around the Microsoft.Build.Framework project/assembly
• GAC and MSBuild
• When globbing returns original filespec

In-depth tech topics

• Reserved and built-in properties
• ProjectReference
• MSBuild Server
• Low priority nodes
• Threading in MSBuild worker nodes
• Nodes orchestration
• Project cache plugin
• Support for remote host objects
• Static graph
• Single project isolated builds: implementation details
• Task isolation
• Target maps
• Managing parallelism in MSBuild
• SDK resolution
• RAR core scenarios

Tasks

• ResolveAssemblyReference

Evaluation

• Evaluation profiling

Logging

• Binary log
• Live logger: how to opt in

Archived Designs

• Resolve Assembly Reference as a service
  • Prototype: https://github.com/dotnet/msbuild/issues/6193

Proposed Designs

• Packages Sourcing
• Secrets Metadata

Community contributions

• MSBuild overview
• Solution parser

Note: community contributions has documentation that was contributed by developers or users, but it might not been fully vetted for accuracy and correctness. Explanations in this folder may not be fully accurate, but can still be very informative for developing an understanding of MSBuild or a specific problem.