How to use the Jenkins MSBuild plug-in in a Jenkinsfile?

Question

I have Jenkins v2.60.3 with the MSBuild Plugin v1.27 installed on Windows.

I have configured the path to my msbuild.exe in Jenkins' Global Tool Configuration. I have also setup a Multi Branch Pipeline in Jenkins that picks up a Jenkinsfile from git repo successfully.

My question is: How do I invoke the MSBuild Plugin as a step in my Jenkinsfile?

Please note I know I can invoke msbuild.exe directly as a Windows batch step but I prefer to go through the MSBuild Plugin if possible. `

Answer 1

It looks like MSBuild is not supported by pipeline yet https://github.com/jenkinsci/pipeline-plugin/blob/master/COMPATIBILITY.md

You can try this in the meantime. https://github.com/jenkinsci/pipeline-examples/blob/master/jenkinsfile-examples/msbuild/Jenkinsfile

Answer 2

Our teams need to migrate a ton of freestyle MSBuild jobs that were created in the UI. mjd's answer helped but still left me scratching my head. The examples just didn't work... until I figured out the disconnect.

Here's the secret sauce:

You have to call the "named msbuild configuration" directly using the "bat" and "tool" commands.

1. go into the Config of one of your freestyle jobs that uses the MSBuild plugin

2. scroll down to the msbuild section and click the "MSBuild Version" drop down, take note of the exact names that are listed. This is your 'named msbuild configuration'. Choose one name that you will use in the next step.

3. open your jenkinsfile, locate the stage and step where you want to call msbuild, then add this line and replace 'MSBuild 15.0' with the name that you chose in step 2:

bat ""${tool 'MSBuild 15.0'}\\msbuild" SolutionName.sln /p:Configuration=Release /p:Platform="Any CPU" /p:ProductVersion=1.0.0.${env.BUILD_NUMBER}"

like so...

(For Declarative Pipelines, you'll need to put this inside of a "script" block. If you don't know what a 'Declarative Pipeline' is, it is one of two styles of writing pipeline scripts in Jenkins using the "groovy" language. For more info here is a comparison of the scripted vs declarative styles.)

4. run the pipeline and examine the output - the code you added in step three won't build anything, you just want to use it to see if msbuild will actually get called before investing anymore time into my script.

(I usually use the Replay button which allows me to edit the script online in Jenkins rather than editing, committing, and pushing to remote repo... it just saves a bit of time debugging.)

5. examine the output of the pipeline job you ran in step 4. You should see something like below indicating that the correct version of MSBuild was called. If not, you either have a typo or your administrator needs to intervene.

workspace\Pipeline_Test>"C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\MSBuild\15.0\Bin\msbuild" SolutionName.sln /p:Configuration=Release /p:Platform="Any CPU" /p:ProductVersion=1.0.0.308 Microsoft (R) Build Engine version 15.9.21+g9802d43bc3 for .NET Framework Copyright (C) Microsoft Corporation. All rights reserved.

6. Congratulations you can now configure your build! Replace SolutionName.sln with your build file and pass the correct parameters to it.

Answer 3

I am surprised that all solutions doesn't work for me.

Platform : Window 10 Jenkins at latest version in 2020-11-05.

I am not sure if there's any reason that window & other OS will cause the pipeline script engine behaved differently.

Below are the possible encountered issues and solution finally combined with the above solution.

1. in my compiler, a single '' will cause error, '' must be escaped by replaced by '\'. which is similar to other char such as '"'
2. ${tool 'MSBuild'} OR ${tool 'MSBuild 15.0'}\msbuild\ does not work, the error is the path cannot specified or cannot find the bat program. It must be an absolute path of the actual msbuild.exe

So this is the working solution for adding MSbuild in the pipeline script in window platform's jenkin

bat '"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin\msbuild" YourSolution.sln /p:Configuration=Release /p:Platform="Any CPU" /p:ProductVersion=1.0.0.${env.BUILD_NUMBER}'