Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions docs/scenarios/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,36 @@ which provides the following features:

Travis-CI
---------

.. todo:: Write about travis-ci
`Travis-CI <http://travis-ci.org/>`_ is a distributed CI server which builds tests
for open source projects for free. It provides multiple workers to run Python tests
on and seamlessly integrates with Github. You can even have it comment on your Pull
Requests whether this particular changeset breaks the build or not. So if you are
hosting your code on Github, travis-ci is a great and easy way to get started with
Continuous Integration.

In order to get started, add a ``.travis.yml`` file to your repository with this
example content::

language: python
python:
- "2.5"
- "2.6"
- "2.7"
- "3.1"
- "3.2"
# command to install dependencies
script: python tests/test_all_of_the_units.py
branches:
only:
- master


This will get your project tested on all the listed Python versions by running the given
script and only build the master branch. There are a lot more options you can enable, like
notifications, before and after steps and much more. The
`travis-ci docs <http://about.travis-ci.org/docs/>`_ explain all of those and are very
thorough.

In order to activate testing for your project, go to `the travis-ci site <http://travis-ci.org/>`_
and login with your Github account. Then activate your project in your profile settings and that's
it. From now on, your project's tests will be run on every push to Github.