diff --git a/README.md b/README.md index 0016f828f..f329fe615 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ Once a build request has been: * approved and configured by [Gatekeeper](https://github.com/travis-ci/travis-gatekeeper), * and its jobs have been scheduled by [Scheduler](https://github.com/travis-ci/travis-scheduler), -they will be picked by a [Worker](https://github.com/travis-ci/worker) +then the jobs will be picked by a [Worker](https://github.com/travis-ci/worker) which will execute the build Bash script as generated by the -[build script compiler](http://github.com/travis-ci/travis-build)). +[build script compiler](http://github.com/travis-ci/travis-build). The worker goes through a series of stages while acquiring and preparing a VM, and running the build script. Each time the state of the job changes the worker @@ -36,16 +36,16 @@ Processing these messages Hub will change the job's `state` in the database, set attributes such as `received_at`, potentially change the respective build's state as well. It will then emit events such as `job:started` or `build:finished` which will send out notifications to other parties (such as -the web UI via Pusher, GitHub commit status or check run updates, email, +the web UI via Pusher, GitHub commit status or check run updates, email, IRC, webhook notifications etc). -## Setup +## Setup First, run `bundle install` to retrieve dependencies from rubygems. Once key dependency, Sidekiq Pro required additional username/password config: ```bash BUNDLE_GEMS__CONTRIBSYS__COM=username:password -bundle config https://gems.contribsys.com/ $BUNDLE_GEMS__CONTRIBSYS__COM +bundle config https://gems.contribsys.com/ $BUNDLE_GEMS__CONTRIBSYS__COM ``` Then, you'll need to install: