Debugging Custom MSBuild Tasks

debugging-custom-msbuild-tasks.md

Debugging Custom MSBuild Tasks

A brief explanation on debugging msbuild tasks. Anything done on CLI (command-line interface) should be done in a Visual Studio Developer Command Prompt. If you have VS installed, search for "Developer command prompt."

This also works for dotnet builds.

Steps

1. Have VS open & breakpoint into your custom task.
2. Open up a developer command prompt.
3. cd your/project/directory
4. set MSBUILDDEBUGONSTART=1
   • =1: A prompt will appear when you build, choose what debugger to attach with.
   • =2: MSBuild will output a PID (process ID). Manually attach with a debugger, then press enter on cmd.
5. msbuild <your-project.csproj>
6. On the prompt, choose your VS.
7. Continue code execution, your breakpoint should hit.
   • If it's not hitting, make sure the task is being called from your project.

Relevant Links

• Tutorial: Creating a custom task. The most recent doc on writing tasks.
• Task Writing. A slightly older doc, but still useful.
• Creating an inline task. How to write a task directly into your project file!
• Debugging An MSBuild Build. For debugging into MSBuild itself.