Skip to content

Commit 627e1a1

Browse files
author
Kenneth Reitz
committed
Merge pull request realpython#181 from mrtazz/patch-2
add section about travis-ci
2 parents 1fdb37a + d8c4d36 commit 627e1a1

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

docs/scenarios/ci.rst

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,36 @@ which provides the following features:
5353

5454
Travis-CI
5555
---------
56-
57-
.. todo:: Write about travis-ci
56+
`Travis-CI <http://travis-ci.org/>`_ is a distributed CI server which builds tests
57+
for open source projects for free. It provides multiple workers to run Python tests
58+
on and seamlessly integrates with Github. You can even have it comment on your Pull
59+
Requests whether this particular changeset breaks the build or not. So if you are
60+
hosting your code on Github, travis-ci is a great and easy way to get started with
61+
Continuous Integration.
62+
63+
In order to get started, add a ``.travis.yml`` file to your repository with this
64+
example content::
65+
66+
language: python
67+
python:
68+
- "2.5"
69+
- "2.6"
70+
- "2.7"
71+
- "3.1"
72+
- "3.2"
73+
# command to install dependencies
74+
script: python tests/test_all_of_the_units.py
75+
branches:
76+
only:
77+
- master
78+
79+
80+
This will get your project tested on all the listed Python versions by running the given
81+
script and only build the master branch. There are a lot more options you can enable, like
82+
notifications, before and after steps and much more. The
83+
`travis-ci docs <http://about.travis-ci.org/docs/>`_ explain all of those and are very
84+
thorough.
85+
86+
In order to activate testing for your project, go to `the travis-ci site <http://travis-ci.org/>`_
87+
and login with your Github account. Then activate your project in your profile settings and that's
88+
it. From now on, your project's tests will be run on every push to Github.

0 commit comments

Comments
 (0)