readme.md in sauce_overage-0.0.2 vs readme.md in sauce_overage-1.0.0

- old
+ new

@@ -2,20 +2,21 @@ [![Gem Version](https://badge.fury.io/rb/sauce_overage.svg)](https://rubygems.org/gems/sauce_overage) [![Build Status](https://travis-ci.org/bootstraponline/sauce_overage.svg)](https://travis-ci.org/bootstraponline/sauce_overage) [![Coverage Status](https://coveralls.io/repos/bootstraponline/sauce_overage/badge.svg?branch=master&service=github&nocache)](https://coveralls.io/github/bootstraponline/sauce_overage?branch=master) -Automatically prevent tests from running on overage minutes by tracking remaining time +Automatically prevent tests from running on overage minutes by tracking remaining time. +#### Jenkins CI Integration + ```bash export SAUCE_USERNAME="..." export SAUCE_ACCESS_KEY="..." -export SAUCE_OVERAGE_LIMIT="300" +# if available minutes are below the limit then the job will fail +export SAUCE_OVERAGE_LIMIT="300" # minutes -# if the limit is breached an error is raised and -# the exit code is set to one -$ sauce_overage -300 minute limit breached (120 remaining) (RuntimeError) - -$ echo $? -1 +sauce_overage +if [ "$?" -ne 0 ]; then + echo "Jenkins build failed due to lack of sauce minutes" + exit 1 +fi ```