Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Check the status of your cruise.rb or build from your Ruby scripts.

branch: master

Fetching latest commit…


Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .document
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CRUISE_URL
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
Octocat-spinner-32 cruisestatus.gemspec

Cruise Status

CruiseStatus allows your Ruby scripts to check the status of your project's build. Use this to abort check-ins when the build has failed, for example.

CruiseStatus currently supports checking builds run on cruisecontrol.rb or on

CruiseControl.rb Example:

To check a cruise.rb build, pass the url to the project RSS feed to CruiseStatus:

require "cruisestatus"

if '' ).pass?
  puts "Build passed!"
  abort "Build failed…Boo!"
end Example:

To check a build on, simply pass the url for the json API:

require "cruisestatus"

if '' ).pass?
  puts "Build passed!"
  abort "Build failed…boo!"

Command-line Usage:

The gem's binary is cruisestatus. Pass a URL to it and cruisestatus will check the build status at that URL and return a non-zero status if any of the builds reported there have failed.

Pass a `-p` option to prompt the user when a build has failed. If the user enters 'y' at the prompt, cruisestatus will return a zero status regardless of build failures.

For example:

$ cruisestatus -p

Build FAILURES: cruisestatus
Are you sure you want to check in? (y/n): y

$ echo $?

$ cruisestatus -p

Build FAILURES: cruisestatus
Are you sure you want to check in? (y/n): n

$ echo $?

You can use this to abort check-ins onto broken builds. (See the post-commit hook in for example). As you know, if the CI build is broken, no one should be checking in new code unless they're fixing the build. You can use cruisestatus to help keep developers honest in that regard.

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.

Build Status


  • support?


Copyright © 2010 Toby Tripp. See LICENSE for details.

Something went wrong with that request. Please try again.