Integrity style dashboard for CI Joe
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
public
spec
views
.document
.gitignore
LICENSE
README.md
Rakefile
VERSION

README.md

buildboard

buildboard is an Integrity style dashboard meant to be used in combination with CI Joe. It does not provide any build features only aggregation of the output from a continuous integration system like CI Joe.

Screenshots:

The project details page:

Details

Getting started

To get started run:

gem install buildboard
buildboard

This will provide you with a running buildboard instance on port 5678 if nothing else is already running on that port.

Setting up CI Joe

To start collecting data from CI Joe setup a build-failed and a build-worked hook with the following content:

#!/bin/sh
update-buildboard --directory [path to your CI Joe working repository]

See the CI Joe documentation if you're in doubt about this.

The options for update-buildboard are:

Usage: update-buildboard [-hpd]

Specific options:
    -h, --host=HOST                  The hostname or ip of the host running buildboard (default 127.0.0.1)
    -p, --port=PORT                  The port buildboard is running on (default 5678)
    -d, --directory=DIRECTORY        The directory containing the CI Joe repository

Inner workings

You don't need to know this if you don't care.

All build information are stored in files in $HOME/.buildboard, they're just YAML files, go peek if you want.

The protocol for integrating with buildboard can be derived from Build#load_file.

Acknowledgements

buildboard is based on and/or stole from, and would like to thank:

  • Integrity provided a nice design to steal
  • CI Joe is the reason buildboard was made
  • Sinatra is the muse that underlies it all
  • Vegas for making it crazy easy to provide a stage for Sinatra

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2010 Jacob Atzen. See LICENSE for details.