Introduction

Jenkins Khan is a PHP tool that helps you manage a Jenkins integration server.

With Jenkins Khan you can easily launch different jobs on your working branches and check the result of each job grouped by your branches.

Why?

If you’ve ever tried to use Jenkins with feature branches, you know that’s not the right tool for this situation. It's kind of a mess to check your jobs state on every branch. We need an overview. Jenkins Khan is a tool over Jenkins to ease the testing of you feature branches.

How?

Jenkins Khan uses Jenkins' API to retrieve the configuration, jobs, jobs parameters, views, statuses, etc. You just have to register your Jenkins URL in Jenkins Khan and enjoy the fun.

Technology stack

Jenkins Khan is a standalone LAMP project.
It is based on common web technologies:

• symfony 1.x
• jQuery
• Twitter bootstrap
• LESS

You can easily install it on your own server.

Licence

Jenkins Khan is an open-source project.
It is published under MIT license.

How do we use it?

Here, at PMSIpilot, when we have to work on a feature, the workflow is this one:

• Create a feature branch
• Work on the feature
• Execute locally relevants tests on the feature branch
• Merge the feature branch into master

So, Jenkins Khan is here to help us follow the execution of the tests run branch by branch.

Because we have a lot of tests suites, we don't launch all of them on each feature branch. So, we choose the most relevant jobs, launch them and start working on another feature while tests are running.

Having a simple view displaying which jobs have been launched branch by branch, and the statuses of these feature branches, is important to us.

Why use Jenkins Khan?

Jenkins Khan	Jenkins CI
Branch view oriented User friendly interface Plugged on top of Jenkins Schedulable jobs	Job view oriented 3 click from homepage to branch's job Too much information

Features

• Display branch by branch the result of each Jenkins' build
• Fully based on Jenkins' API
  • No configuration (except your Jenkins' URL)
  • All views, jobs, configurations are immediatly available
• Relaunch builds
• Relaunch every build on a feature branch
• Register or schedule builds without launching them on Jenkins
• User-friendly interface.
• Provide its own API to retrieve status, relaunch jobs for a feature branch.

Requirements

• PHP 5.2+
• PHP Curl extension
• MySQL 5+
• Jenkins 1.4+
• Jenkins Git Plugin

Documentation

Documentation is hosted in the project wiki on Github:

• How to install Jenkins Khan
• Jenkins Khan's API reference

Contributing

Get the source code on GitHub and use pull requests to improve it.

Authors

Jenkins Khan is an open-source side project of PMSIpilot, developped by:

• See contributors

Thanks to the PMSIpilot team for their suggestions and support.