Worker is the component of Travis CI that will run a CI job on some form of compute instance. It's responsible for getting the bash script from travis-build, spin up the compute instance (VM, Docker container, or maybe something different), upload the bash script, run it and stream the logs back to travis-logs. It also sends state updates to travis-hub.

Find the version you wish to install on the GitHub Releases page and download either the darwin-amd64 binary for OS X or the linux-amd64 binary for Linux. No other operating systems or architectures have pre-built binaries at this time.

Use the ./bin/travis-worker-install script, or take a look at the packagecloud instructions.

1. clone this down
2. install Go and gvt.
3. make

Travis Worker is configured with environment variables or command line flags via the codegangsta/cli library. A list of the non-dynamic flags and environment variables may be found by invoking the built-in help system:

travis-worker --help

Each provider requires its own configuration, which must be provided via environment variables namespaced by TRAVIS_WORKER_{PROVIDER}_, e.g. for the docker provider:

export TRAVIS_WORKER_DOCKER_ENDPOINT="tcp://localhost:4243"
export TRAVIS_WORKER_DOCKER_PRIVILEGED="false"
export TRAVIS_WORKER_DOCKER_CERT_PATH="/etc/secret-docker-cert-stuff"

To inspect the parsed configuration in a format that can be used as a base environment variable configuration, use the --echo-config flag, which will exit immediately after writing to stdout:

travis-worker --echo-config

0. make
1. ${GOPATH%%:*}/bin/travis-worker

Travis Worker has two shutdown modes: Graceful and immediate. The graceful shutdown will tell the worker to not start any additional jobs, but finish the jobs it is currently running before it shuts down. The immediate shutdown will make the worker stop the jobs it's working on and requeue them, and clean up any open resources (shut down VMs, cleanly close connections, etc.)

To start a graceful shutdown, send an INT signal to the worker (for example using kill -INT). To start an immediate shutdown, send a TERM signal to the worker (for example using kill -TERM).

Travis Worker is built via the standard go commands, and dependencies managed by gvt.

To work with the dependencies you need to do the following first

• Have this repository checked out
• Install gvt with github.com/FiloSottile/gvt

To update and existing vendored dependency, do the following in this directory:

• gvt update name/of/dependency e.g. gvt update github.com/pkg/sftp

To add a new dependency, do the following:

• gvt fetch name/of/package e.g. gvt fetch github.com/pkg/sftp

This section is for anyone wishing to contribute code to Worker. The code itself should have godoc-compatible docs (which can be viewed on godoc.org: https://godoc.org/github.com/travis-ci/worker), this is mainly a higher-level overview of the code.

The parts of the release process that haven't yet been automated look like this:

• review the diff since last release for silliness
• decide what the version bump should be
• update ./CHANGELOG.md (in a release prep branch)
• tag accordingly after merge
• update github release tag with relevant section from ./CHANGELOG.md
• attach binaries to github release tag

See LICENSE file.

© 2014-2016 Travis CI GmbH