comparison README.txt @ 184:a5709ef5e275

additional documentation
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 01 Feb 2011 19:06:08 -0800
parents f8dccf3377d9
children c7172ca54dff
comparison
equal deleted inserted replaced
183:225f88b6b1d6 184:a5709ef5e275
1 autobot 1 autobot
2 ======= 2 =======
3 3
4 buildbot for the A*Team 4 buildbot for the A*Team
5 5
6 Using autobot
7 6
8 Autobot may be installed using the Install script:: 7 What is autobot?
8 ----------------
9 9
10 curl http://... 10 autobot is a continuous integration solution for the Automation and
11 Tools Team. We have a lot of software. We're really talented, so
12 usually it doesn't break. But we're not infalliable. Our robot ally,
13 autobot, is there to test things for us. Let's me autobot!
14
15
16 Installing autobot
17 ------------------
18
19 autobot may be installed using the Install script::
20
21 curl http://k0s.org/mozilla/hg/autobot/raw-file/tip/INSTALL.sh | bash
11 22
12 This will create a virtualenv and install autobot for development 23 This will create a virtualenv and install autobot for development
13 ($VIRTUAL_ENV/src/autobot). You can create a master-slave pair by 24 ($VIRTUAL_ENV/src/autobot).
14 running ``create-autobot`` after activating the virtualenv. This is 25
15 mostly useful for autobot development. The scripts ``create-autobot-master`` and 26
27 Setting up a buildmaster and slave
28 ----------------------------------
29
30 Once you have autobot installed and the virtualenv activated, you'll
31 want to create a buildmaster and a buildslave.
32
33 You can create a master-slave pair by running ``create-autobot`` after
34 activating the virtualenv. This is mostly useful for autobot
35 development. The scripts ``create-autobot-master`` and
16 ``create-autobot-slave`` are also available. The scripts will prompt you 36 ``create-autobot-slave`` are also available. The scripts will prompt you
17 for a factory. The factories are from ``autobot.projects`` and its 37 for a factory. The factories are from ``autobot.projects`` and its
18 subdirectories. 38 subdirectories.
19 39
40
41 Using autobot
42 -------------
43
44 It is important to remember that continuous integration is a safety
45 net, not a first line of defense.
46
47
20 Projects 48 Projects
21 -------- 49 --------
50
51 What does autobot test?
22 52
23 * logparser [WORKING] 53 * logparser [WORKING]
24 * profilemanager [IN FLIGHT] 54 * profilemanager [IN FLIGHT]
25 * mozmill [IN FLIGHT] 55 * mozmill [IN FLIGHT]
26 * devicemanager [IN FLIGHT] 56 * devicemanager [IN FLIGHT]
27 * firebug [TODO] 57 * firebug [TODO]
28 * jetpack [TODO] 58 * jetpack [TODO]
29 59
60
61 Adding a New Project
62 --------------------
63
64 Occassionally, you'll need to add a new project to test.