Jenkins
The leading open-source automation server, Jenkins provides hundreds of plugins to support building, deploying, and automating any project. This architecture makes it easy to extend Jenkins to support MSBuild files, Git version control, etc.
Set-up
Jenkins is installed on a build server. In my set-up, the build server is the same as the release server, but this can be configured differently.
Download and install Jenkins for your platform here: https://jenkins-ci.org/
After installation Jenkins is available on its default port: http://localhost:8080/
So, let’s take a closer look at my application architecture and components
- Platform: .NET 4.5.2
- IDE: Visual Studio 2015 (MSBuild files)
- Application type: Windows Service
- NuGet: Package Manager used for all references.
- Source Control: Git (github.com)
Configure Jenkins
Jenkins has plugins for understanding Git repositories, MSBuild files, and various other technologies. In the current set-up, we only need to extend Jenkins with those two plugins.
Install the Git Plugin for Jenkins
- Open Jenkins, http://localhost:8080/.
- Navigate to "Manage Jenkins".
- Navigate to "Manage Plugins".
- Direct link:http://localhost:8080/pluginManager.
- Use the "filter" box to search for "Git plugin" and install the plugin.
Install the MSBuild Plugin for Jenkins
- Open Jenkins, http://localhost:8080/.
- Navigate to "Manage Jenkins".
- Navigate to "Manage Plugins".
- Direct link: http://localhost:8080/pluginManager.
- Use the "filter" box to search for "MSBUILD plugin" and install the plugin.
Jenkins now understands MSBuild files and Git source control but we still need to configure the MSBuild Plugin with a path to the msbuild.exe that we would like to use.
MSBuild configuration
When the MSBuild plugin was installed, it added its own configuration options to the Jenkins global configuration page.
- Navigate to http://localhost:8080/.
- Click "Manage Jenkins".
- Click "Configure System".
- Scroll down the list until you find "MSBuild".
- Click the "MSBuild installations..." button.
- Click “Add MSBuild”.
- Give the new MSBuild configuration a name like "MSBuild-default".
- In the path field, insert the fully qualified path to exe.
- On my server, the path is C:\Program Files.
(x86)\MSBuild\14.0\Bin\msbuild.exe, but this can be different on your system.
- Read below for more information about MSBuild and how to install it.
- Click "Save".
MSBuild installation
MSBuild is installed with Visual Studio, it’s the build system that Visual Studio uses when you select "build" or hit "F5".
It’s not always feasible or even possible to install Visual Studio on your build machine.
This could be due to license and security issues, etc.
To accommodate this Microsoft has released a separate package called: "Microsoft Build Tools 2015" that contains all you need for using MSBuild.
Direct download
https://www.microsoft.com/en-us/download/details.aspx?id=48159
After successful installation, you have MSBuild available on the build server and with that, you get the path value for step 8, above.
With this step done Jenkins is ready to build and deploy with MSBuild and Git.
Create a new Jenkins build project
It’s now time to point Jenkins to the source code and start building.
- Open Jenkins, http://localhost:8080/.
- Select "new".
Direct link http://localhost:8080/view/All/newJob.
- Give the project the name "Windows Service Deployment" or something you can remember.
- Select “Freestyle project”.
- Select “Ok”.
- Next, expand the “Source Code Management” region by selecting “Git”.
- Complete the Git configuration by filling in the blanks with a URL to your repository and optional credentials (if needed).
Jenkins can also work with branches. In this set-up, I will leave the branch as the default (Master) but you can select whatever fits your needs.
If you don't already have a Git repository ready for testing, you can use the pre-cooked repository here:
https://github.com/martinesmann/jenkins-ci-template
The same was built and deployed in our case.
- If you haven’t done so already, click “Save” to persist your changes and navigate back to the main "Project" page.
Testing the Git configuration
Now we can test if the Git Source Management tab has been configured correctly and if we can clone the source code.
We are not yet building anything, only cloning the source. Building part will come in a moment. First, let's make sure Jenkins can clone the source from the repository.
- Navigate to the "Project" page.
- Click the “Build Now” to start a "Build".
- In the "Build History" region you should now see a build in progress with the name #1".
- If everything completes as expected, then “SUCCESS” and the bubble maker stays blue, if not it turns red.
- To see the build details, click the build number "#1".
- Then, click "Console Output". You should see something similar to what I have here.
***What’s important to note here is the path
to the "workspace" as this is where the source code is downloaded to and built from. This knowledge can be very helpful when debugging the CI setup.***
Building the source
The next step is to compile and build the source code.
Navigate to the "project" page
Select “Configure”
Find the "Add build step"
Select the "Build a Visual Studio project or solution using MSBuild".
We need to configure a few values here:
- First, select the MSBuild version (we configured this in a previous step).
- Then give the path to the *.sln or *.proj file for your project.
For the pre-cooked repository, the path is src\MyWindowsService\MyWindowsService\Deploy-Windows-Service-Via-MSBuild.proj
Please note
We are not pointing to the solution file, rather we are pointing to a custom MSBuild file that is in the project. This MSBuild file is handling all steps involved with compiling and deploying the Windows Service.
You can read more about this MSBuild file from the author's own blog, here: http://mrchief.calepin.co/deploying-windows-service-via-msbuild
If you are using the pre-cooked repository, your setup should look like this,
Click Save.
NuGet package restore
If we were to build the project right now it would fail due to missing NuGet packages. Therefore we need to restore the NuGet packages before attempting to build the source.
nuget.exemakes this task very easy, we simply need to fire this command on the solution file:
nuget restore "path to *.sln" file
No surprise Jenkins can handle multiple build steps, so let's add a build step to enable NuGet to restore.
- Navigate to the "project" page.
- Select "Configure".
- Find the "Add build step".
- Click "Add build step".
- Select "Execute Windows batch command".
- Re-arrange the build order by dragging the new build step to the top.
- In the Command field insert,
nuget restore src\MyWindowsService\
- Click "Save".
We are now ready to build the project!
The final test! Primetime!
- Navigate to the project page
- Click the "Build now" link
- Wait for the build to complete
- Check that the Service is installed and running,
- On Windows open the "Services" management window
- Scroll down to you find the service "My Windows Service (...)"
Congratulations! You have now successfully configured Jenkins to download, compile, and deploy a .NET Windows Service! Automation ROCKS!
The same was hosted on AWS Windows Instance.
Below are the server details, so you can access and verify.
Public DNS
ec2-54-244-209-42.us-west-2.compute.amazonaws.com
Try with Remote Desktop Connection
Password will be shared separately.
ajay jangamPosted Mar 26, 2020, 6:07 AM
This is exact copy of Martin post which is posted in 2016 see https://blog.couchbase.com/continuous-deployment-with-jenkins-and-net/
Vaibhav WalkePosted Jul 26, 2019, 7:15 AM
Not a clear article,it doesn't say where to configure server settings to deploy source code.
praveen dussaPosted May 17, 2019, 1:07 AM
Very nice....
ratnakar DayalPosted May 9, 2019, 10:17 AM
Thanks for your valuable efforts. But I am not clear where you have configured that will deploy. I think this will only bulid and create package only.
Yogesh DeshpandePosted Jan 24, 2019, 3:05 AM
Very good and helpful article and clean explanation.
Dipu KakatiPosted Aug 31, 2018, 7:41 AM
Nice artical saurav keep it up....it is very helpfull to clear my interview.thanks a lot
Guest UserPosted Jul 31, 2018, 8:38 PM
Good article
pradipta sahooPosted Jul 6, 2018, 5:36 AM
Very good explanation... I think this is copy of the blog https://blog.couchbase.com/continuous-deployment-with-jenkins-and-net/
donthula chandrashekarPosted Apr 27, 2018, 12:26 AM
Good article Saurav.
sai mahaPosted Apr 27, 2018, 12:26 AM
Nice article Saurav..
srikanth dharmavaramPosted Apr 11, 2018, 6:01 AM
Good article looking some more
K.G. TriinadhPosted Apr 9, 2018, 5:20 AM
Good article nice work around this saurav
Nani sreenivasPosted Apr 9, 2018, 5:11 AM
Awesome article Saurav, Keep going. thanks