status Build Status

Updates pull requests on github using the statuses api (, with latest build from Jenkins and QA status


gem install update_status

on your branch run

$: status

This will generate a .status.yml file in the current directory, you will need to edit this file with your credentials.


  :username: Jenkins username
  :password: Jenkins password
  :token: Githubs API token (
  :owner: Owner of the repository eg. dougdroper
  :repo: eg. status
  :ci_url: eg.
  :qa_required: true

add .status.yml to .gitignore

When your branch has passed QA

$: status -q pass

You can pass a different branch

$: status -b other_feature_branch


$: status -b other_feature_branch -q pass

You can also pass based on the SHA

$: status -s SHA -q pass

When qa_required is false then there is no need to pass in a qa option


$: status -h

Github oauth

You need an API token to interact with githubs api

$: curl -u "YOUR GITHUB USERNAME" -d '"add_scopes":["repo"]'

  "id": 1,
  "url": "",
  "app": {
    "name": "GitHub API",
    "url": ""
  "token": "NEW TOKEN",
  "note": null,
  "note_url": null,
  "created_at": "2013-02-11T17:02:36Z",
  "updated_at": "2013-02-11T17:02:36Z",
  "scopes": [

This generates a new token, now you need to add_scopes to the id of the returned token

$: curl -u "YOUR GITHUB USERNAME" -d '"add_scopes":["repo"]'

Then add this token in the .status.yml file

Contributing to status

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright (c) 2012 Douglas Roper. See LICENSE.txt for further details.