comparison README.txt @ 186:c7172ca54dff

more docs
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 01 Feb 2011 19:19:36 -0800
parents a5709ef5e275
children bba97450cbc2
comparison
equal deleted inserted replaced
185:d8351b7b9edb 186:c7172ca54dff
33 You can create a master-slave pair by running ``create-autobot`` after 33 You can create a master-slave pair by running ``create-autobot`` after
34 activating the virtualenv. This is mostly useful for autobot 34 activating the virtualenv. This is mostly useful for autobot
35 development. The scripts ``create-autobot-master`` and 35 development. The scripts ``create-autobot-master`` and
36 ``create-autobot-slave`` are also available. The scripts will prompt you 36 ``create-autobot-slave`` are also available. The scripts will prompt you
37 for a factory. The factories are from ``autobot.projects`` and its 37 for a factory. The factories are from ``autobot.projects`` and its
38 subdirectories. 38 subdirectories. You can list the available factories with
39 ``create-autobot --list-factories`` (or ``create-autobot-master
40 --list-factories``).
39 41
42 Running ``create-autobot --help`` will give the variables you can set
43 when it makes a new bot for you (``create-autobot-master`` and
44 ``create-autobot-slave`` also have a ``--help``, the variables in
45 ``create-autobot`` being a superset of these).
40 46
47 If you don't specify a variable, the default will be used to create
48 your particular bot. You can (probably) change it later.
49
50
41 Using autobot 51 Using autobot
42 ------------- 52 -------------
43 53
44 It is important to remember that continuous integration is a safety 54 It is important to remember that continuous integration is a safety
45 net, not a first line of defense. 55 net, not a first line of defense.
55 * mozmill [IN FLIGHT] 65 * mozmill [IN FLIGHT]
56 * devicemanager [IN FLIGHT] 66 * devicemanager [IN FLIGHT]
57 * firebug [TODO] 67 * firebug [TODO]
58 * jetpack [TODO] 68 * jetpack [TODO]
59 69
70 The projects are obtained from any factories in subdirectories of
71 ``autobot.projects`` (use
72 ``python -c 'from autobot import projects; print projects.__file__'``
73 to see this location).
74
60 75
61 Adding a New Project 76 Adding a New Project
62 -------------------- 77 --------------------
63 78
64 Occassionally, you'll need to add a new project to test. 79 Occassionally, you'll need to add a new project to test.
80
81
82 Is your autobot being feisty?
83 -----------------------------
84
85 Let me know! I'd like to make autobot a solution that works for all
86 stake-holders, and if you're reading this, that means you!
87
88
89 TODO
90 ----
91
92 No software of any size is ever finished
93
94 * singular checkout of repos on slaves
95 * passing slave environment to master -> MozInfo