Skip to content

kutsal/jenkins-build-monitor-plugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jenkins CI Build Monitor Plugin

Build Monitor Plugin provides a highly visible view of the status of selected Jenkins jobs.

It easily accommodates different computer screen sizes and is ideal as an Extreme Feedback Device to be displayed on a screen on your office wall. (Inspired by the no longer maintained RadiatorView plugin).

Build Status Stories in Backlog

Have a question? Perhaps it's already been answered - check the FAQ section below.

Setting up

To create a new Build Monitor View, click on the "New View" tab, select "Build Monitor View" and select jobs you wish to display on the monitor. You can have as many Build Monitor Views as you want - the most popular approach is to have one per team or one per project.

Features

I'd like to keep the plugin as simple as possible and avoid cluttering the view with statistics I don't find of high value in the context of a Build Monitor.

Current functionality includes:

  1. Displaying the status and progress of selected jobs
  2. Displaying names of people who might be responsible for "breaking the build"
  3. Easily customisable number of columns and size of the font used, making it easier to accommodate screens of different sizes
  4. UI configuration is stored in a cookie, making it possible to display different number of columns and using different font size on each screen at your office

All the features I'm hoping to add in the near future are listed in the "Roadmap" section of this README

A picture is worth a thousand words

A place to start Adding jobs Two columns view Three columns view Supports Jenkins Claim Plugin

TDD

If you'd like to understand more about the logic behind the Build Monitor Plugin, feel free to have a look at the tests that drove the design.

Known Limitations

Browser support - Modern web browsers only

To avoid unnecessary complexity when implementing the view layer I decided to use CSS 3 flexbox. The standard is currently supported by most modern web browsers, so if your browser doesn't support this feature - consider upgrading :)

Roadmap

  1. Display what triggered the build (SCM change, another job, manual)
  2. Display how long a given job has been failing for
  3. Support for Claim Plugin
  4. Support for Gravatar
  5. Display parameters of parametrized jobs
  6. Persist layout configuration changes in a long-lived cookie.

FAQ

How do I let my teammates know that I'm fixing a broken build?

By claiming it. Build Monitor supports Jenkins Claim Plugin, so once you have it installed, enable "Broken build claiming" in the "Post-build actions" of your Jenkins job. From now on you'll be able to claim any further broken builds and Build Monitor will pick it up.

You might also be interested in a script that enables claiming on all your Jenkins jobs.

How do I know what broke the build?

Wouldn't it be great to know what made your build fail? Well of course it would. Build Monitor supports Jenkins Buld Failure Analyzer Plugin so get it, teach it and Build Monitor will tell you what the Failure Analyzer found out.

I have too many jobs on one screen, what should I do?

You have several options here:

  1. review the granularity of your jobs: If you have too many low-level jobs displayed on one screen, consider consolidating them using Promoted Builds Plugin or MultiJob Plugin
  2. use job filters: Build Monitor supports Jenkins View Job Filters Plugin, if you have it installed
  3. get a bigger screen ...

Red and green colours are lovely, but I'm colour blind ...

There's a colour blind mode you can enable in the Settings

License: MIT

Open Source Software Used

Inspired by

No longer maintained Radiator View Plugin

About

Jenkins CI Build Monitor Plugin

Resources

License

Stars

Watchers

Forks

Packages

No packages published