README
1How to setup a buildslave?
2--------------------------
3
41. Install Buildbot
5-------------------
6Buildbot is a Python application, you need to install Python 2.2+.
7
8Download & install:
9- Twisted 2.2: http://twistedmatrix.com/trac/
10- ZopeInterface 3.0.1: http://www.zope.org/Products/ZopeInterface
11- Buildbot 0.7.2: http://sourceforge.net/project/showfiles.php?group_id=73177
12
13The Buildbot installer creates a buildbot script in /usr/bin. On Windows,
14buildbot.bat is installed in the %PYTHON\Scripts folder.
15
16Test your buildbot install by running the buildbot script.
17
182. Creating a buildslave
19------------------------
20Creating a buildslave is explained in the Buildbot manual:
21http://buildbot.sourceforge.net/manual-0.7.2.html#Creating-a-buildslave
22
23Before you can install the buildslave, you'll need some information from
24the buildmaster administrator:
25
26- your botname and password. The botname is a unique id for your buildslave.
27Current botnames include the OS+version, compiler and processor architecture.
28(eg. osx10.4-gcc4.0.1-ia32, xp-vs2003-ia32...)
29- hostname and port on which the buildmaster is listening.
30- hostname and port on which the TryScheduler is listening.
31- username and password for the FTP server where you can send the test log-
32 files.
33
34Make sure you fill in the info/host file with some information concerning your
35buildslave.
36
373. Setting up the buildslave
38----------------------------
39A build on a slave is always triggered and managed by the Buildmaster. In fact,
40by connecting to the buildmaster, the slave gives full shell access on his
41machine to the buildmaster! Make sure you run the slave in an account with
42limited access.
43
44The build process is split in 4 steps.
45- svn checkout or update
46- build
47- check
48- clean
49
50The first step is handled by the buildbot code (SVNStep) and can not be
51further configured on the buildslave.
52For all the other steps you have to provide scripts and put them in the
53slavedir/[botname] folder.
54
55You can copy and reuse the scripts the other buildbot slave owners use for
56Windows, Linux or Mac buildslaves. You can find them here:
57http://svn.apache.org/repos/asf/subversion/trunk/tools/buildbot/slaves
58
594. Builds
60---------
61A build will be triggered each time someone commits changes on trunk or
62branches/1.4.x. If the buildslave is not online, then the build will be
63stored in the queue and started when the buildslave connects.
64
65Normally each build only includes the changes of one commit. However, when
66multiple changes arive during a previous build, those will be combined in
67a next build.
68
69The buildmaster looks at each commit and decides if they are important enough
70to trigger a build. Documentation, contrib, www... changes are typically
71ignored.
72
735. Try
74------
75Buildbot has a feature that allows a Subversion developer to test a patch she's
76working on on one of the builders. Example, someone working on Linux might want
77to test a major change first on a Windows builder before committing the patch.
78
79It's up to you to choose whether your buildslave can accept patches or not,
80there's no obligation. Basically by allowing patches to be tried on your
81buildslave you give people the ability to compile and execute arbitrary code
82on your machine.
83Try access is password protected and will be reserved to Subversion full
84committers.
85
86How to use the try feature:
87TryScheduler is installed on its own dedicated port. It can be used by
88a client with 'buildbot try':
89http://buildbot.sourceforge.net/manual-0.7.5.html#try
90
91Contact the buildmaster administrator for the username & password which you
92need to use 'buildbot try'.
93