Skip to content

Commit

Permalink
(docs) Readme explains Build Monitor features and set up process more…
Browse files Browse the repository at this point in the history
… clearly.
  • Loading branch information
jan-molak committed Aug 17, 2014
1 parent 42f2da2 commit 5182702
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 28 deletions.
Binary file added .README/Setting_up.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 48 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,73 @@
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).
(Inspired by the no longer maintained [RadiatorView](https://wiki.jenkins-ci.org/display/JENKINS/Radiator+View+Plugin) plugin).

[![Build Status](https://smartcode.ci.cloudbees.com/buildStatus/icon?job=jenkins-build-monitor-plugin)](https://smartcode.ci.cloudbees.com/job/jenkins-build-monitor-plugin/)
[![Acceptance Tests Status](https://saucelabs.com/buildstatus/build-monitor)](https://saucelabs.com/u/build-monitor)
[![Stories in Backlog](https://badge.waffle.io/jan-molak/jenkins-build-monitor-plugin.png?label=backlog&title=Backlog)](https://waffle.io/jan-molak/jenkins-build-monitor-plugin)

Have a question? Perhaps it's already been answered - check the [FAQ](#faq) section below.

## Setting up
## Features

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.
I'd like to keep the plugin as simple as possible, yet useful and effective.

## Features
Current functionality of the Build Monitor plugin:

* Displays the status and progress of selected jobs. The view is updated automatically every couple of seconds using AJAX, so no "Enable Auto Refresh" needed.
* Displays the names of people who might be responsible for "breaking the build".
* Supports the [Claim plugin](https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin), so that you can see who's fixing a broken build
* Supports [View Job Filters](https://wiki.jenkins-ci.org/display/JENKINS/View+Job+Filters), so that you can easily create Build Monitors for "slow builds", "only failing", etc.
* Supports [Build Failure Analyzer](https://wiki.jenkins-ci.org/display/JENKINS/Build+Failure+Analyzer), so that you know not only *who*, but also *what* broke the build; [learn more](http://bit.ly/JBMBuild102)
* Supports [CloudBees Folders Plugin](https://wiki.jenkins-ci.org/display/JENKINS/CloudBees+Folders+Plugin), so that you can have project- and team-specific nested Build Monitors; [learn more](http://bit.ly/JBMBuild117)
* The number of columns and size of the font used is easily customisable, making it trivial to accommodate screens of different sizes.
* UI configuration is stored in a cookie, making it possible to display different number of columns and using different font size on each of the screens at your office.
* Can work in a colour-blind-friendly mode; [learn more](https://github.com/jan-molak/jenkins-build-monitor-plugin/issues/30#issuecomment-35849019)

All the previous releases together with their change logs are [listed here](https://bitly.com/JBMReleases).

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.
## Your feedback matters!

Current functionality includes:
Do you find Build Monitor useful? Give it a star! ★

Found a bug? Raise [an issue](https://github.com/jan-molak/jenkins-build-monitor-plugin/issues?state=open)
or submit a pull request ([start with this mini-dev guide](https://github.com/jan-molak/jenkins-build-monitor-plugin/wiki/Development-Guide), it might come in handy).

Have feedback? Let me know on twitter: [@JanMolak](https://twitter.com/JanMolak)

[![Flattr Button](http://api.flattr.com/button/button-static-50x60.png "Flattr This!")](https://flattr.com/submit/auto?user_id=JanMolak&url=https%3A%2F%2Fgithub.com%2Fjan-molak%2Fjenkins-build-monitor-plugin "Jenkins Build Monitor Plugin")

## Setting up

1. Displaying the status and progress of selected jobs
1. Displaying names of people who might be responsible for "breaking the build"
1. Easily customisable number of columns and size of the font used, making it easier to accommodate screens of different sizes
1. 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
![Setting up](.README/Setting_up.png)

All the features I'm hoping to add in the near future are listed in the "Roadmap" section of this README
Simple, right? :-) 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.

# A picture is worth a thousand words

![A place to start](.README/0_A_place_to_start.png)
![Adding jobs](.README/1_Adding_jobs.png)
![Three columns view](.README/2_Three_columns_view.png)
![Supports Claim and Build Failure Analyzer plugins](.README/3_Two_columns_view_with_claim_and_build_failure_analyzer_plugins.png)
![Colour-blind mode](.README/4_Colour_blind_mode.png)

## Roadmap and work in progress

If you'd like to know what's coming next - have a look at the project's [kanban board](https://waffle.io/jan-molak/jenkins-build-monitor-plugin).
Here's how the columns work:

* Ideas - ideas up for discussion. If you'd like to see any of them making it into the Build Monitor project - vote on them or submit a pull request.
* Backlog - features most wanted by the Build Monitor Community. I'll get them done as soon as I have a spare moment. Feel free to help out! :-)
* In progress - stuff I'm currently working on and will make it into the next release.
* Done - done and deployed. Grab the latest version from your Jenkins Update Centre or the [Releases](https://bitly.com/JBMReleases) page.

If you want to stay up-to-date with the project news - [follow me on twitter](https://twitter.com/JanMolak).

## (A)TDD

If you'd like to understand more about the logic behind the Build Monitor Plugin,
have a look at the [tests that drove the design](/src/test/java/com/smartcodeltd/jenkinsci/plugins/).

## FAQ

### How do I let my teammates know that I'm fixing a broken build?
Expand All @@ -59,11 +93,6 @@ You have several options here:
### Red and green colours are lovely, but I'm colour blind ...
There's a colour blind mode you can [enable in the Settings](https://github.com/jan-molak/jenkins-build-monitor-plugin/issues/30#issuecomment-35849019)

## 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](/src/test/java/com/smartcodeltd/jenkinsci/plugins/buildmonitor/viewmodel/JobViewTest.java).

## Known Limitations

### Browser support - Modern web browsers only
Expand All @@ -72,15 +101,6 @@ To avoid unnecessary complexity when implementing the view layer I decided to us
The standard is currently supported by [most modern web browsers](http://caniuse.com/flexbox),
so if your browser doesn't support this feature - [consider upgrading](http://browsehappy.com/) :)

## Roadmap

1. Display what triggered the build (SCM change, another job, manual)
1. Display how long a given job has been failing for
1. ~~Support for [Claim Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin)~~
1. Support for [Gravatar](http://gravatar.com)
1. Display parameters of parametrized jobs
1. ~~Persist layout configuration changes in a long-lived cookie.~~

## License: MIT

## Open Source Software Used
Expand All @@ -93,4 +113,4 @@ so if your browser doesn't support this feature - [consider upgrading](http://br

## Inspired by

No longer maintained [Radiator View Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Radiator+View+Plugin)
No longer maintained [Radiator View Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Radiator+View+Plugin)

0 comments on commit 5182702

Please sign in to comment.