So I’m in the process of automating the build and publish of a .Net WinForms application with Squirrel in Windows.
The first step in achieving this is to get the project building programmatically, outside of Visual Studio.
Coming from a Linux background I prefer working with Bash over Powershell or Batch and Git Bash is my terminal of choice within Windows.
Discovering the tools we need
The application uses framework 4.6.1 and I wasn’t sure what version of the tools were needed. To find out what tools were already installed on my system I ran:
This listed a couple of versions, 2.0, 3.5 and 4.0.30319. I decided to try to build the project with the latest installed tools using:
Which caused the following error:
Project file contains ToolsVersion="15.0".
So now I know I need version 15.0 of the build tools.
One mystery solved.
Downloading and Installing the BuildTools
A quick search led me to this download page and after downloading the
Build Tools for Visual Studio 2017, I ran the executable.
As I’m only currently trying to build a particular framework, under the Windows section I checked
.NET desktop build tools and only checked the optional installation of
Testing tools core features - Build Tools, as .NET Framework 4.6.1 SDK and targeting pack is included by default.
Now we’re cooking with gas.
So now we’ve got the correct build tools, let’s check we can build the project successfully. From a Powershell terminal, type:
C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\15.0\Bin\MSBuild.exe "C:\path\to\project\solution.sln"
Working with Bash
Now we’ve proven that the tools work, we just need to make them accessible from Git Bash.
In order to be able to access MSBuild.exe from Git Bash we’ll need to add the path to MSBuild.exe used above to the $PATH environment variable. This is quick and easy.
PATH="$PATH:/c/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/MSBuild/15.0/Bin"
Some things to note from the above command:
– Forward slashes are used instead of backslashes for paths in Bash
– We can access the C:\ drive using just the drive letter in Git Bash
Now we can run the following command from our Git Bash window:
We should get identical output to when we ran the command initially in Powershell.
Adding switches to MSBuild
The final thing we will want to do is add some switches to the build command so we can Clean/Build/Rebuild and set the Configuration to Debug or Release.
In Powershell we could run the following:
MSBuild.exe "/c/path/to/solution/solution.sln" /t:Rebuild /p:Configuration=Release
Due to Bash using
/ for file paths, we need to escape any
/ characters with another
/. So in Git Bash the above command becomes:
MSBuild.exe "/c/path/to/solution/solution.sln" //t:Rebuild //p:Configuration=Release
And there we have it, building a .NET solution with Git Bash and it only took a few minutes. By putting this in a script, we can now automate building of our WinForms solutions, ready for packaging and deployment with Squirrel.
In discovering the above, the below answers on StackOverflow helped steer me in the right direction.
As described in the answer for this question, we could also script the install of the build tools, rather than using the GUI, because who in their right mind wants to use the GUI???
That will be the next step so we can script the install of our build tools, making it effortless to configure a new build server.