From: Daniel Schauenberg <d@unwiredcouch.com>
Date: Wed, 4 Jul 2012 05:27:18 +0000 (-0300)
Subject: add section about travis-ci
X-Git-Url: https://git.eng.unimelb.edu.au/public?p=python-guide.git;a=commitdiff_plain;h=d8c4d3612e9e0e671f1706fa164a6621aa4f5a46

add section about travis-ci
---

diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst
index 659f440..3a80c70 100644
--- a/docs/scenarios/ci.rst
+++ b/docs/scenarios/ci.rst
@@ -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.