#115:Make-WithProperties-easier-to-use-internally.patch
[buildbot.git] / NEWS
blob26a01eb8cdda80c2077d2b12879f249d00106bde
1 User visible changes in Buildbot.             -*- outline -*-
3 * Release 0.?.? (?)
5 ** Things You Need To Know
7 *** builder names must not start with an underscore (`_').
9 These are now reserved for internal buildbot purposes, such as the magic
10 "_all" pseudo-builder that the web pages use to allow force-build buttons
11 that start builds on all Builders at once.
14 * Release 0.7.6 (30 Sep 2007)
16 ** Things You Need To Know
18 *** 'buildbot upgrade-master'
20 Each time you install a new version of Buildbot, you should run the new
21 'buildbot upgrade-master' command on each of your pre-existing buildmasters.
22 This will add files and fix (or at least detect) incompatibilities between
23 your old config and the new code.
25 *** new WebStatus page
27 The Waterfall has been replaced by the more general WebStatus display,
28 described below. WebStatus serves static files from a new public_html/
29 directory that lives in the buildmaster's basedir. Files like index.html,
30 buildbot.css, and robots.txt are served directly from that directory, so any
31 modifications you wish to make should be made to those files. In particular,
32 any custom CSS you've written should be copied into public_html/buildbot.css.
33 The 'upgrade-master' command will populate this directory for you.
35 The old Waterfall page is deprecated, but it should continue to work for
36 another few releases. It is now a subclass of WebStatus which just replaces
37 the default root URL with another copy of the /waterfall resource.
39 *** Compatiblity: Python-2.3 or newer, Twisted-2.0 or newer
41 No compatiblity losses here, buildbot-0.7.6 is compatible with the same
42 versions of python and twisted that 0.7.5 was.
44 Buildbot is tested on a regular basis (http://buildbot.buildbot.net) against
45 nearly a full matrix of Python-(2.3,2.4,2.5) * Twisted-(2.0,2.1,2.2,2.4,2.5).
47 *** New Buildbot Home Page
49 Buildbot has moved to a new Trac instance at http://buildbot.net/ , and all
50 new bugs and tickets should be filed there. The old sourceforge bugs at
51 http://buildbot.sf.net/ will slowly be migrated over. Mailing lists are still
52 managed at sourceforge, and downloads are still available there.
54 *** Changed/Deprecated master.cfg Keys and Classes
56 c['sources'] (plural) has been replaced by c['change_source'] (singular).
58 c['bots'] has been replaced by c['buildslaves'], and it expects a list of
59 BuildSlave instances instead of tuples. See below for more details.
61 The 'freshcvsmail' change source has been deprecated, and will be removed in
62 the next release.
64 The html.Waterfall status target has been deprecated, and replaced by
65 html.WebStatus .
67 ** New Features
69 *** WebStatus
71 The new WebStatus display is a superset of the old Waterfall. It contains a
72 waterfall as a sub-page, but it also contains pages with more compact
73 representations of recent build status. The "one_line_per_build" page
74 contains just that, and "one_box_per_builder" shows just the information from
75 the top of the waterfall page (last-finished-build and current-activity).
77 The initial page (when you hit the root of the web site) is served from
78 index.html, and provides links to the Waterfall as well as the other pages.
80 Most of these pages can be filtered by adding query arguments to the URL.
81 Adding "?builder=XYZ" will cause the page to only show results for the given
82 builder. Adding "?builder=XYZ&builder=ABC" will show results for either
83 builder. "?branch=trunk" will limit the results to builds that involved code
84 from the trunk.
86 The /waterfall page has arguments to hide those annoying "buildslave
87 connected" messages, to start and and at arbitrary times, and to auto-refresh
88 at a chosen interval (with a hardcoded minimum of 15 seconds). It also has a
89 "help" page with forms that will help you add all of these nifty filtering
90 arguments.
92 The recommended practice is to modify the index.html file to include links to
93 the filtered pages that you find most useful.
95 Note that WebStatus defaults to allowForce=False, meaning that the display
96 will not offer or accept "Force Build" or "Stop Build" controls. (The old
97 Waterfall defaults to allowForce=True).
99 The new WebStatus pages try very hard to use only relative links, making life
100 better when the Buildbot sits behind an HTTP reverse proxy.
102 In addition, there is a rudimentary XMLRPC server run by the WebStatus
103 object. It only has two methods so far, but it will acquire more in the
104 future. The first customer of this is a project to add a buildbot plugin to
105 Trac.
107 *** BuildFactory.addStep(Step(args))
109 BuildFactories can be set up either with a complete list of steps, or by
110 calling the .addStep() method repeatedly. The preferred way to provide a step
111 is by instantiating it, rather than giving a class/kwargs pair. This gives
112 the BuildStep class a chance to examine the arguments (and complain about
113 anything it doesn't like) while the config file is being read and problems
114 are being logged. For example, the old-style:
116  from buildbot.process.factory import BuildFactory, s
117  steps = [s(CVS, cvsroot="blah", mode="copy"),
118           s(Compile, command=["make", "all"]),
119           s(Test, command=["make", "test"]),
120          ]
121  f = BuildFactory(steps)
123 is now:
125  f = BuildFactory()
126  f.addStep( CVS(cvsroot="blah", mode="copy") )
127  f.addStep( Compile(command=["make", "all"]) )
128  f.addStep( Test(command=["make", "test"]) )
130 Authors of BuildStep subclasses which override __init__ to add new arguments
131 must register them with self.addFactoryArguments(**newargs) to make sure that
132 those classes will work with this new style, otherwise the new arguments will
133 be lost.
135 Using class/kwargs pairs is deprecated, and will be removed in a future
136 release.
139 *** BuildSlave instances, max_builds=, notify_on_missing=
141 Buildslave specification has changed a lot in this release. The old config:
143  c['bots'] = [ ("bot1name", "bot1passwd"),
144                ("bot2name", "bot2passwd") ]
146 is now:
148  from buildbot.buildslave import BuildSlave
149  c['slaves'] = [ BuildSlave("bot1name", "bot1passwd"),
150                  BuildSlave("bot2name", "bot2passwd") ]
152 This new form gives us the ability to add new controls. The first is
153 "max_builds=", which imposes a concurrency limit that is like the usual
154 SlaveLock, but gives the buildmaster the opportunity to find a different
155 slave to run the build. (the buildslave is chosen before the SlaveLock is
156 claimed, so pure SlaveLocks don't let you take full advantage of build
157 farms).
159 The other addition is "notify_on_missing=", which accepts an email address
160 (or list of addresses), and sends a message when the buildslave has been
161 disconnected for more than an hour (configurable with missing_timeout=). This
162 may be useful when you expect that the buildslave hosts should be available
163 most of the time, and want to investigate the reasons that it went offline.
166 ** Other Improvements
168 The IRC bot has been refactored to make it easier to add instant-messaging
169 status delivery in the future. The IM plugins are not yet written, though.
171 When multiple buildslaves are available for a given build, one of them will
172 be picked at random. In previous releases, the first one on the list was
173 always picked. This helps to add a certain measure of load-balancing. More
174 improvements will be made in the future.
176 When the buildslave does a VC checkout step that requires clobbering the
177 build directory (i.e. in all modes except for 'update'), the buildslave will
178 first set the permissions on all build files to allow their deletion, before
179 it attempts to delete them. This should fix some problems in which a build
180 process left non-user-writable files lying around (frequently a result of
181 enthusiastic unit tests).
183 The BuildStep's workdir= argument can now accept a WithProperties()
184 specification, allowing greater control over the workdir.
186 Support for the 'Bazaar' version control system (/usr/bin/bzr) has been
187 added, using the buildbot.steps.source.Bzr class. This is a replacement for
188 the old 'Arch' (/usr/bin/tla and /usr/bin/baz) systems, which are still
189 supported by Buildbot with the source.Arch and source.Bazaar classes,
190 respectively. Unfortunately the old baz system claimed the 'Bazaar' classname
191 early, so the new system must use source.Bzr instead of the desired
192 source.Bazaar . A future release might change this.
194 A rudimentary Gnome Panel applet is provided in contrib/bb_applet.py, which
195 provides 'buildbot statusgui' -like colored status boxes inside the panel.
196 Installing it is a bit tricky, though.
198 The 'buildbot try' command now accepts a '--diff=foo.patch' argument, to let
199 you provide a pre-computed patch. This makes it easier to test out patches
200 that you've looked over for safety, without first applying them to your local
201 source tree.
203 A new Mercurial change source was added, hg_buildbot.py, which runs as an
204 in-process post-commit hook. This gives us access to much more information
205 about the change, as well as being much faster.
207 The email-based changesource have been refactored, to make it easier to write
208 new mail parsers. A parser for the SVN "commit-email.pl" script has been
209 added.
211 ** Bugs Fixed
213 Far too many to count. Please see
214 http://buildbot.net/trac/query?status=closed&milestone=0.7.6 for a partial
215 list of tickets closed for this release, and the ChangeLog for a complete
216 list of all changes since 0.7.5 .
219 * Release 0.7.5 (10 Dec 2006)
221 ** Things You Need To Know
223 *** The Great BuildStep Renaming
225 All BuildSteps have moved! They used to be classes in buildbot.process.step,
226 but now they all have separate modules in buildbot.steps.* . They have been
227 split out into separate categories: for example, the source checkout steps
228 are now buildbot.steps.source.CVS, buildbot.steps.source.Darcs, etc. The most
229 commonly used one is probably buildbot.steps.shell.ShellCommand . The
230 python-specific steps are in buildbot.steps.python, and the Twisted-specific
231 steps are in buildbot.steps.python_twisted .
233 You will need to update your master.cfg files to use the new names. The old
234 names are deprecated and will be removed altogether in the next release.
236 *** Compatibility
238 Buildbot now requires python-2.3 or later. Buildbot now requires
239 Twisted-2.0.0 or later. Support for earlier versions of both has finally been
240 removed. If you discover it works with unsupported versions, please return
241 your Buildbot to the factory for repairs :-).
243 Buildbot has *not* yet been tested against the recent python-2.5 release. It
244 has been tested against the latest SVN version of Twisted, but only in
245 conjunction with python-2.4 .
247 ** new features
249 *** reconfiguring a Builder no longer causes a disconnect/reconnect cycle
251 This means that sending SIGHUP to the master or running 'buildbot reconfig
252 MASTERDIR' command no longer interrupts any current builds, nor does it lose
253 pending builds like it did before. This involved a fairly substantial
254 refactoring of the various internal BotPerspective/BotMaster/Builder classes.
255 Note that reconfiguring Schedulers still loses any Changes that were waiting
256 for the tree to become stable: hopefully this will be fixed in the next
257 release.
259 *** 'buildbot start/restart/reconfig' now show logs until startup is complete
261 These commands now have additional code to follow twistd.log and display all
262 the lines that are emitted from the beginning of the start/reconfig action
263 until it has completed. This gives you a chance to see any problems detected
264 in the config file without needing to manually look in twistd.log or use
265 another shell to 'tail -f' it. This also makes it clear which config file is
266 being used. This functionality is not available under windows.
268 In addition, if any problems are detected during 'start' or 'restart' (but
269 not reconfig), the buildbot command will terminate with a non-zero exit
270 status, making it easier to use in scripts. Closes SF#1517975.
272 *** Locks now take maxCount=N to allow multiple simultaneous owners
274 This allows Locks to be non-exclusive but still limit maximum concurrency.
275 Thanks to James Knight for the patch. Closes SF#1434997.
277 *** filetransfer steps
279 buildbot.steps.transfer.FileUpload is a buildstep that will move files from
280 the slave to the master. Likewise, FileDownload will move files from the
281 master down to the buildslave. Many thanks to Albert Hofkamp for contributing
282 these classes. Closes SF#1504631.
284 *** pyflakes step
286 buildbot.steps.python.PyFlakes will run the simple 'pyflakes' static analysis
287 tool and parse the results to tell you about undefined names, unused imports,
288 etc. You'll need to tell it how to run pyflakes, usually with something like
289 command=["pyflakes", "src/packagedir"] or the like. The default command is
290 "make pyflakes", which assumes that you have a suitable target in your
291 top-level Makefile.
293 *** Monotone support
295 Nathaniel Smith has contributed initial support for the Monotone version
296 control system. The code still needs docs and tests, but on the other hand it
297 has been in use by the Monotone buildbot for a long time now, so it is
298 probably fairly stable.
300 *** Tinderbox support
302 Ben Hearsum and the Mozilla crew have contributed some classes to allow
303 Buildbot to work with Tinderbox clients. One piece is
304 buildbot.changes.bonsaipoller.BonsaiPoller, which is a ChangeSource that
305 polls a Bonsai server (which is a kind of web-vased viewcvs CGI script) to
306 discover source code changes. The other piece is
307 buildbot.status.tinderbox.TinderboxMailNotifier, which is a status plugin
308 that sends email in the same format as Tinderbox does, which allows a number
309 of Tinderbox tools to be driven by Buildbot instead.
311 *** SVN Poller
313 Niklaus Giger contributed a ChangeSource (buildbot.changes.svnpoller) which
314 polls a remote SVN repository on a periodic basis. This is useful when, for
315 whatever reason, you cannot add a post-commit hook script to the repository.
316 This obsoletes the external contrib/svn_watcher.py script.
318 ** notes for plugin developers
320 *** IStatusLog.readlines()
322 This new method makes it easier for a status plugin (or a
323 BuildStep.createSummary method) to walk through a StatusLog one line at a
324 time. For example, if you wanted to create an extra logfile that just
325 contained all the GCC warnings from the main log, you could use the
326 following:
328     def createSummary(self, log):
329         warnings = []
330         for line in log.readlines():
331             if "warning:" in line:
332                 warnings.append()
333         self.addCompleteLog('warnings', "".join(warnings))
335 The "BuildStep LogFiles" section of the user's manual contains more
336 information. This method is not particularly memory-efficient yet (it reads
337 the whole logfile into memory first, then splits it into lines); this will be
338 improved in a future release.
340 ** bug fixes
342 *** Update source.SVN to work with the new SVN-1.4.0
344 The latest subversion changed the behavior in an unusual situation which
345 caused the unit tests to fail. This was unlikely to cause a problem in actual
346 usage, but the tests have been updated to pass with the new version.
348 *** update svn_buildbot.py to avoid mangling filenames
350 Older versions of this script were stripping the wrong number of columns from
351 the output of 'svnlook changed', and would sometimes mangle filenames. This
352 has been fixed. Closes SF#1545146.
354 *** logfiles= caused subsequent build failures under Windows
356 Earlier versions of buildbot didn't explicitly close any logfiles= file
357 handles when the build finished. On windows (where you cannot delete a file
358 that someone else is reading), this could cause the next build to fail as the
359 source checkout step was unable to delete the old working directory. This has
360 been fixed. Closes SF#1568415.
362 *** logfiles= didn't work on OS-X
364 Macintosh OS-X has a different behavior when reading files that have reached
365 EOF, the result was that logfiles= sometimes didn't work. Thanks to Mark Rowe
366 for the patch.
368 ** other changes
370 The 'buildbot sighup MASTERDIR' command has been replaced with 'buildbot
371 reconfig MASTERDIR', since that seems to be a slightly more meaningful name.
372 The 'sighup' form will remain as an alias.
375 * Release 0.7.4 (23 Aug 2006)
377 ** Things You Need To Know
379 The PBChangeSource's prefix= argument has changed, you probably need to add a
380 slash now. This is mostly used by sites which use Subversion and
381 svn_buildbot.py.
383 The subcommands that are used to create a buildmaster or a buildslave have
384 changed. They used to be called 'buildbot master' and 'buildbot slave'. Now
385 they are called 'buildbot create-master' and 'buildbot create-slave'. Zipf's
386 Law suggests that these are more appropriate names for these
387 infrequently-used commands.
389 The syntax for the c['manhole'] feature has changed.
391 ** new features
393 *** full Perforce support
395 SF#1473939: large patch from Scott Lamb, with docs and unit tests! This
396 includes both the step.P4 source-checkout BuildStep, and the changes.p4poller
397 ChangeSource you'll want to feed it. P4 is now supported just as well as all
398 the other VC systems. Thanks Scott!
400 *** SSH-based Manhole
402 The 'manhole' feature allows buildbot developers to get access to a python
403 read/eval/print loop (REPL) inside the buildmaster through a network
404 connection. Previously, this ran over unencrypted telnet, using a simple
405 username/password for access control. The new release defaults to encrypted
406 SSH access, using either username/password or an authorized_keys file (just
407 like sshd). There also exists an unencrypted telnet form, but its use is
408 discouraged. The syntax for setting up a manhole has changed, so master.cfg
409 files that use them must be updated. The "Debug options" section in the
410 user's manual provides a complete description.
412 *** Multiple Logfiles
414 BuildSteps can watch multiple log files in realtime, not just stdout/stderr.
415 This works in a similar fashion to 'tail -f': the file is polled once per
416 second, and any new data is sent to the buildmaster.
418 This requires a buildslave running 0.7.4 or later, and a warning message is
419 produced if used against an old buildslave (which will otherwise produce no
420 data). Use "logfiles={'name': 'filename'}" to take advantage of this feature
421 from master.cfg, and see the "ShellCommand" section of the user's manual for
422 full documentation.
424 The 'Trial' buildstep has been updated to use this, to display
425 _trial_temp/test.log in realtime. It also knows to fall back to the previous
426 "cat" command if the buildslave is too old.
428 *** BuildStep URLs
430 BuildSteps can now add arbitrary URLs which will be displayed on the
431 Waterfall page in the same place that Logs are presented. This is intended to
432 provide a link to generated HTML pages, such as the output of a code coverage
433 tool. The step is responsible for somehow uploading the HTML to a web server:
434 this feature merely provides an easy way to present the HREF link to the
435 user. See the "BuildStep URLs" section of the user's manual for details and
436 examples.
438 *** LogObservers
440 BuildSteps can now attach LogObservers to various logfiles, allowing them to
441 get real-time log output. They can use this to watch for progress-indicating
442 events (like counting the number of files compiled, or the number of tests
443 which have run), and update both ETA/progress-tracking and step text. This
444 allows for more accurate ETA information, and more information passed to the
445 user about how much of the process has completed.
447 The 'Trial' buildstep has been updated to use this for progress tracking, by
448 counting how many test cases have run.
450 ** new documentation
452 What classes are useful in your master.cfg file? A table of them has been
453 added to the user's manual, in a section called "Index of Useful Classes".
455 Want a list of all the keys in master.cfg? Look in the "Index of master.cfg
456 keys" section.
458 A number of pretty diagrams have been added to the "System Architecture"
459 portion of the manual, explaining how all the buildbot pieces fit together.
461 An HTML form of the user's manual is now shipped in the source tarball. This
462 makes it a bit bigger: sorry about that. The old PyCon-2003 paper has been
463 removed from the distribution, as it is mostly supplanted by the user's
464 manual by this point.
466 ** bugfixes
468 SF#1217699 + SF#1381867: The prefix= argument to PBChangeSource has been
469 changed: now it does just a simple string-prefix match and strip. The
470 previous behavior was buggy and unhelpful. NOTE: if you were using prefix=
471 before, you probably need to add a slash to the end of it.
473 SF#1398174: ignore SVN property changes better, fixed by Olivier Bonnet
475 SF#1452801: don't double-escape the build URL, fixed by Olivier Bonnet
477 SF#1401121: add support for running py2exe on windows, by Mark Hammond
479 reloading unchanged config files with WithProperties shouldn't change anything.
481 All svn commands now include --non-interactive so they won't ask for
482 passwords. Instead, the command will fail if it cannot be performed without
483 user input.
485 Deprecation warnings with newer versions of Twisted have been hushed.
487 ** compatibility
489 I haven't actually removed support for Twisted-1.3.0 yet, but I'd like to.
491 The step_twisted default value for --reporter matches modern Twisteds,
492 though, and won't work under 1.3.0.
494 ShellCommand.flunkOnFailure now defaults to True, so any shell command which
495 fails counts as a build failure. Set this to False if you don't want this
496 behavior.
498 ** minor features
500 contrib/darcs_buildbot.py contains a new script suitable for use in a darcs
501 commit-hook.
503 Hovering a cursor over the yellow "Build #123" box in the Waterfall display
504 will pop up an HTML tooltip to show the reason for the build. Thanks to Zandr
505 Milewski for the suggestion.
507 contrib/CSS/*.css now contains several contributed stylesheets to make the
508 Waterfall display a bit less ugly. Thanks to John O'Duinn for gathering them.
510 ShellCommand and its derivatives can now accept either a string or a list of
511 strings in the description= and descriptionDone= arguments. Thanks to Paul
512 Winkler for the catch.
515 * Release 0.7.3 (23 May 2006)
517 ** compatibility
519 This release is compatible with Twisted-1.3.0, but the next one will not be.
520 Please upgrade to at least Twisted-2.0.x soon, as the next buildbot release
521 will require it.
523 ** new features
525 *** Mercurial support
527 Support for Mercurial version control system (http://selenic.com/mercurial)
528 has been added. This adds a buildbot.process.step.Mercurial BuildStep. A
529 suitable hook script to deliver changes to the buildmaster is still missing.
531 *** 'buildbot restart' command
533 The 'buildbot restart BASEDIR' command will perform a 'buildbot stop' and
534 'buildbot start', and will attempt to wait for the buildbot process to shut
535 down in between. This is useful when you need to upgrade the code on your
536 buildmaster or buildslave and want to take it down for a minimum amount of
537 time.
539 *** build properties
541 Each build now has a set of named "Build Properties", which can be set by
542 steps and interpolated into ShellCommands. The 'revision' and 'got_revision'
543 properties are the most interesting ones available at this point, and can be
544 used e.g. to get the VC revision number into the filename of a generated
545 tarball. See the user's manual section entited "Build Properties" for more
546 details.
548 ** minor features
550 *** IRC now takes password= argument
552 Useful for letting your bot claim a persistent identity.
554 *** svn_buildbot.py is easier to modify to understand branches
555 *** BuildFactory has a new .addStep method
556 *** p4poller has new arguments
557 *** new contrib scripts: viewcvspoll, svnpoller, svn_watcher
559 These poll an external VC repository to watch for changes, as opposed to
560 adding a hook script to the repository that pushes changes into the
561 buildmaster. This means higher latency but may be easier to configure,
562 especially if you do not have authority on the repository host.
564 *** VC build property 'got_revision'
566 The 'got_revision' property reports what revision a VC step actually
567 acquired, which may be useful to know when building from HEAD.
569 *** improved CSS in Waterfall
571 The Waterfall display has a few new class= tags, which may make it easier to
572 write custom CSS to make it look prettier.
574 *** robots_txt= argument in Waterfall
576 You can now pass a filename to the robots_txt= argument, which will be served
577 as the "robots.txt" file. This can be used to discourage search engine
578 spiders from crawling through the numerous build-status pages.
580 ** bugfixes
582 *** tests more likely to pass on non-English systems
584 The unit test suite now sets $LANG='C' to make subcommands emit error
585 messages in english instead of whatever native language is in use on the
586 host. This improves the chances that the unit tests will pass on such
587 systems. This affects certain VC-related subcommands too.
589 test_vc was assuming that the system time was expressed with a numeric
590 timezone, which is not always the case, especially under windows. This
591 probably works better now than it did before. This only affects the CVS
592 tests.
594 'buildbot try' (for CVS) now uses UTC instead of the local timezone. The
595 'got_revision' property is also expressed in UTC. Both should help deal with
596 buggy versions of CVS that don't parse numeric timezones properly.
599 * Release 0.7.2 (17 Feb 2006)
601 ** new features
603 *** all TCP port numbers in config file now accept a strports string
605 Sometimes it is useful to restrict certain TCP ports that the buildmaster
606 listens on to use specific network interfaces. In particular, if the
607 buildmaster and SVN repository live on the same machine, you may want to
608 restrict the PBChangeSource to only listen on the loopback interface,
609 insuring that no external entities can inject Changes into the buildbot.
610 Likewise, if you are using something like Apache's reverse-proxy feature to
611 provide access to the buildmaster's HTML status page, you might want to hide
612 the real Waterfall port by having it only bind to the loopback interface.
614 To accomplish this, use a string like "tcp:12345:interface=127.0.0.1" instead
615 of a number like 12345. These strings are called "strports specification
616 strings", and are documented in twisted's twisted.application.strports module
617 (you can probably type 'pydoc twisted.application.strports' to see this
618 documentation). Pretty much everywhere the buildbot takes a port number will
619 now accept a strports spec, and any bare numbers are translated into TCP port
620 numbers (listening on all network interfaces) for compatibility.
622 *** buildslave --umask control
624 Twisted's daemonization utility (/usr/bin/twistd) automatically sets the
625 umask to 077, which means that all files generated by both the buildmaster
626 and the buildslave will only be readable by the account under which the
627 respective daemon is running. This makes it unnecessarily difficult to share
628 build products (e.g. by symlinking ~/public_html/current_docs/ to a directory
629 within the slave's build directory where each build puts the results of a
630 "make docs" step).
632 The 'buildbot slave <PARAMS>' command now accepts a --umask argument, which
633 can be used to override the umask set by twistd. If you create the buildslave
634 with '--umask=022', then all build products will be world-readable, making it
635 easier for other processes (run under other accounts) to access them.
637 ** bug fixes
639 The 0.7.1 release had a bug whereby reloading the config file could break all
640 configured Schedulers, causing them to raise an exception when new changes
641 arrived but not actually schedule a new build. This has been fixed.
643 Fixed a bug which caused the AnyBranchScheduler to explode when branch==None.
644 Thanks to Kevin Turner for the catch. I also think I fixed a bug whereby the
645 TryScheduler would explode when it was given a Change (which it is supposed
646 to simply ignore).
648 The Waterfall display now does more quoting of names (including Builder
649 names, BuildStep names, etc), so it is more likely that these names can
650 contain unusual characters like spaces, quotes, and slashes. There may still
651 be some problems with these kinds of names, however.. please report any bugs
652 to the mailing list.
655 * Release 0.7.1 (26 Nov 2005)
657 ** new features
659 *** scheduler.Nightly
661 Dobes Vandermeer contributed a cron-style 'Nightly' scheduler. Unlike the
662 more-primitive Periodic class (which only lets you specify the duration
663 between build attempts), Nightly lets you schedule builds for specific times
664 of day, week, month, or year. The interface is very much like the crontab(5)
665 file. See the buildbot.scheduler.Nightly docstring for complete details.
667 ** minor new features
669 *** step.Trial can work with Trial from Twisted >2.1.0
671 The 'Trial' step now accepts the trialMode= argument, which should be a list
672 of strings to be added to trial's argv array. This defaults to ["-to"], which
673 is appropriate for the Trial that ships in Twisted-2.1.0 and earlier, and
674 tells Trial to emit non-colorized verbose output. To use this step with
675 trials from later versions of Twisted, this should be changed to
676 ["--reporter=bwverbose"].
678 In addition, you can now set other Trial command-line parameters through the
679 trialArgs= argument. This is a list of strings, and defaults to an empty list.
681 *** Added a 'resubmit this build' button to the web page
683 *** Make the VC-checkout step's description more useful
685 Added the word "[branch]" to the VC step's description (used in the Step's
686 box on the Waterfall page, among others) when we're checking out a
687 non-default branch. Also add "rNNN" where appropriate to indicate which
688 revision is being checked out. Thanks to Brad Hards and Nathaniel Smith for
689 the suggestion.
691 ** bugs fixed
693 Several patches from Dobes Vandermeer: Escape the URLs in email, in case they
694 have spaces and such. Fill otherwise-empty <td> elements, as a workaround for
695 buggy browsers that might optimize them away. Also use binary mode when
696 opening status pickle files, to make windows work better. The
697 AnyBranchScheduler now works even when you don't provide a fileIsImportant=
698 argument.
700 Stringify the base revision before stuffing it into a 'try' jobfile, helping
701 SVN and Arch implement 'try' builds better. Thanks to Steven Walter for the
702 patch.
704 Fix the compare_attrs list in PBChangeSource, FreshCVSSource, and Waterfall.
705 Before this, certain changes to these objects in the master.cfg file were
706 ignored, such that you would have to stop and re-start the buildmaster to
707 make them take effect.
709 The config file is now loaded serially, shutting down old (or replaced)
710 Status/ChangeSource plugins before starting new ones. This fixes a bug in
711 which changing an aspect of, say, the Waterfall display would cause an
712 exception as both old and new instances fight over the same TCP port. This
713 should also fix a bug whereby new Periodic Schedulers could fire a build
714 before the Builders have finished being added.
716 There was a bug in the way Locks were handled when the config file was
717 reloaded: changing one Builder (but not the others) and reloading master.cfg
718 would result in multiple instances of the same Lock object, so the Locks
719 would fail to prevent simultaneous execution of Builds or Steps. This has
720 been fixed.
722 ** other changes
724 For a long time, certain StatusReceiver methods (like buildStarted and
725 stepStarted) have been able to return another StatusReceiver instance
726 (usually 'self') to indicate that they wish to subscribe to events within the
727 new object. For example, if the buildStarted() method returns 'self', the
728 status receiver will also receive events for the new build, like
729 stepStarted() and buildETAUpdate(). Returning a 'self' from buildStarted() is
730 equivalent to calling build.subscribe(self).
732 Starting with buildbot-0.7.1, this auto-subscribe convenience will also
733 register to automatically unsubscribe the target when the build or step has
734 finished, just as if build.unsubscribe(self) had been called. Also, the
735 unsubscribe() method has been changed to not explode if the same receiver is
736 unsubscribed multiple times. (note that it will still explode is the same
737 receiver is *subscribed* multiple times, so please continue to refrain from
738 doing that).
741 * Release 0.7.0 (24 Oct 2005)
743 ** new features
745 *** new c['schedulers'] config-file element (REQUIRED)
747 The code which decides exactly *when* a build is performed has been massively
748 refactored, enabling much more flexible build scheduling. YOU MUST UPDATE
749 your master.cfg files to match: in general this will merely require you to
750 add an appropriate c['schedulers'] entry. Any old ".treeStableTime" settings
751 on the BuildFactory instances will now be ignored. The user's manual has
752 complete details with examples of how the new Scheduler classes work.
754 *** c['interlocks'] removed, Locks and Dependencies now separate items
756 The c['interlocks'] config element has been removed, and its functionality
757 replaced with two separate objects. Locks are used to tell the buildmaster
758 that certain Steps or Builds should not run at the same time as other Steps
759 or Builds (useful for test suites that require exclusive access to some
760 external resource: of course the real fix is to fix the tests, because
761 otherwise your developers will be suffering from the same limitations). The
762 Lock object is created in the config file and then referenced by a Step
763 specification tuple or by the 'locks' key of the Builder specification
764 dictionary. Locks come in two flavors: MasterLocks are buildmaster-wide,
765 while SlaveLocks are specific to a single buildslave.
767 When you want to have one Build run or not run depending upon whether some
768 other set of Builds have passed or failed, you use a special kind of
769 Scheduler defined in the scheduler.Dependent class. This scheduler watches an
770 upstream Scheduler for builds of a given source version to complete, and only
771 fires off its own Builders when all of the upstream's Builders have built
772 that version successfully.
774 Both features are fully documented in the user's manual.
776 *** 'buildbot try'
778 The 'try' feature has finally been added. There is some configuration
779 involved, both in the buildmaster config and on the developer's side, but
780 once in place this allows the developer to type 'buildbot try' in their
781 locally-modified tree and to be given a report of what would happen if their
782 changes were to be committed. This works by computing a (base revision,
783 patch) tuple that describes the developer's tree, sending that to the
784 buildmaster, then running a build with that source on a given set of
785 Builders. The 'buildbot try' tool then emits status messages until the builds
786 have finished.
788 'try' exists to allow developers to run cross-platform tests on their code
789 before committing it, reducing the chances they will inconvenience other
790 developers by breaking the build. The UI is still clunky, but expect it to
791 change and improve over the next few releases.
793 Instructions for developers who want to use 'try' (and the configuration
794 changes necessary to enable its use) are in the user's manual.
796 *** Build-On-Branch
798 When suitably configured, the buildbot can be used to build trees from a
799 variety of related branches. You can set up Schedulers to build a tree using
800 whichever branch was last changed, or users can request builds of specific
801 branches through IRC, the web page, or (eventually) the CLI 'buildbot force'
802 subcommand.
804 The IRC 'force' command now takes --branch and --revision arguments (not that
805 they always make sense). Likewise the HTML 'force build' button now has an
806 input field for branch and revision. Your build's source-checkout step must
807 be suitably configured to support this: for SVN it involves giving both a
808 base URL and a default branch. Other VC systems are configured differently.
809 The ChangeSource must also provide branch information: the 'buildbot
810 sendchange' command now takes a --branch argument to help hook script writers
811 accomplish this.
813 *** Multiple slaves per Builder
815 You can now attach multiple buildslaves to each Builder. This can provide
816 redundancy or primitive load-balancing among many machines equally capable of
817 running the build. To use this, define a key in the Builder specification
818 dictionary named 'slavenames' with a list of buildslave names (instead of the
819 usual 'slavename' that contains just a single slavename).
821 *** minor new features
823 The IRC and email status-reporting facilities now provide more specific URLs
824 for particular builds, in addition to the generic buildmaster home page. The
825 HTML per-build page now has more information.
827 The Twisted-specific test classes have been modified to match the argument
828 syntax preferred by Trial as of Twisted-2.1.0 and newer. The generic trial
829 steps are still suitable for the Trial that comes with older versions of
830 Twisted, but may produce deprecation warnings or errors when used with the
831 latest Trial.
833 ** bugs fixed
835 DNotify, used by the maildir-watching ChangeSources, had problems on some
836 64-bit systems relating to signed-vs-unsigned constants and the DN_MULTISHOT
837 flag. A workaround was provided by Brad Hards.
839 The web status page should now be valid XHTML, thanks to a patch by Brad
840 Hards. The charset parameter is specified to be UTF-8, so VC comments,
841 builder names, etc, should probably all be in UTF-8 to be displayed properly.
843 ** creeping version dependencies
845 The IRC 'force build' command now requires python2.3 (for the shlex.split
846 function).
849 * Release 0.6.6 (23 May 2005)
851 ** bugs fixed
853 The 'sendchange', 'stop', and 'sighup' subcommands were broken, simple bugs
854 that were not caught by the test suite. Sorry.
856 The 'buildbot master' command now uses "raw" strings to create .tac files
857 that will still function under windows (since we must put directory names
858 that contain backslashes into that file).
860 The keep-on-disk behavior added in 0.6.5 included the ability to upgrade old
861 in-pickle LogFile instances. This upgrade function was not added to the
862 HTMLLogFile class, so an exception would be raised when attempting to load or
863 display any build with one of these logs (which are normally used only for
864 showing build exceptions). This has been fixed.
866 Several unnecessary imports were removed, so the Buildbot should function
867 normally with just Twisted-2.0.0's "Core" module installed. (of course you
868 will need TwistedWeb, TwistedWords, and/or TwistedMail if you use status
869 targets that require them). The test suite should skip all tests that cannot
870 be run because of missing Twisted modules.
872 The master/slave's basedir is now prepended to sys.path before starting the
873 daemon. This used to happen implicitly (as a result of twistd's setup
874 preamble), but 0.6.5 internalized the invocation of twistd and did not copy
875 this behavior. This change restores the ability to access "private.py"-style
876 modules in the basedir from the master.cfg file with a simple "import
877 private" statement. Thanks to Thomas Vander Stichele for the catch.
880 * Release 0.6.5 (18 May 2005)
882 ** deprecated config keys removed
884 The 'webPortnum', 'webPathname', 'irc', and 'manholePort' config-file keys,
885 which were deprecated in the previous release, have now been removed. In
886 addition, Builders must now always be configured with dictionaries: the
887 support for configuring them with tuples has been removed.
889 ** master/slave creation and startup changed
891 The buildbot no longer uses .tap files to store serialized representations of
892 the buildmaster/buildslave applications. Instead, this release now uses .tac
893 files, which are human-readable scripts that create new instances (rather
894 than .tap files, which were pickles of pre-created instances). 'mktap
895 buildbot' is gone.
897 You will need to update your buildbot directories to handle this. The
898 procedure is the same as creating a new buildmaster or buildslave: use
899 'buildbot master BASEDIR' or 'buildbot slave BASEDIR ARGS..'. This will
900 create a 'buildbot.tac' file in the target directory. The 'buildbot start
901 BASEDIR' will use twistd to start the application.
903 The 'buildbot start' command now looks for a Makefile.buildbot, and if it
904 finds one (and /usr/bin/make exists), it will use it to start the application
905 instead of calling twistd directly. This allows you to customize startup,
906 perhaps by adding environment variables. The setup commands create a sample
907 file in Makefile.sample, but you must copy this to Makefile.buildbot to
908 actually use it. The previous release looked for a bare 'Makefile', and also
909 installed a 'Makefile', so you were always using the customized approach,
910 even if you didn't ask for it. That old Makefile launched the .tap file, so
911 changing names was also necessary to make sure that the new 'buildbot start'
912 doesn't try to run the old .tap file.
914 'buildbot stop' now uses os.kill instead of spawning an external process,
915 making it more likely to work under windows. It waits up to 5 seconds for the
916 daemon to go away, so you can now do 'buildbot stop BASEDIR; buildbot start
917 BASEDIR' with less risk of launching the new daemon before the old one has
918 fully shut down. Likewise, 'buildbot start' imports twistd's internals
919 directly instead of spawning an external copy, so it should work better under
920 windows.
922 ** new documentation
924 All of the old Lore-based documents were converted into a new Texinfo-format
925 manual, and considerable new text was added to describe the installation
926 process. The docs are not yet complete, but they're slowly shaping up to form
927 a proper user's manual.
929 ** new features
931 Arch checkouts can now use precise revision stamps instead of always using
932 the latest revision. A separate Source step for using Bazaar (an alternative
933 Arch client) instead of 'tla' was added. A Source step for Cogito (the new
934 linux kernel VC system) was contributed by Brandon Philips. All Source steps
935 now accept a retry= argument to indicate that failing VC checkouts should be
936 retried a few times (SF#1200395), note that this requires an updated
937 buildslave.
939 The 'buildbot sendchange' command was added, to be used in VC hook scripts to
940 send changes at a pb.PBChangeSource . contrib/arch_buildbot.py was added to
941 use this tool; it should be installed using the 'Arch meta hook' scheme.
943 Changes can now accept a branch= parameter, and Builders have an
944 isBranchImportant() test that acts like isFileImportant(). Thanks to Thomas
945 Vander Stichele. Note: I renamed his tag= to branch=, in anticipation of an
946 upcoming feature to build specific branches. "tag" seemed too CVS-centric.
948 LogFiles have been rewritten to stream the incoming data directly to disk
949 rather than keeping a copy in memory all the time (SF#1200392). This
950 drastically reduces the buildmaster's memory requirements and makes 100MB+
951 log files feasible. The log files are stored next to the serialized Builds,
952 in files like BASEDIR/builder-dir/12-log-compile-output, so you'll want a
953 cron job to delete old ones just like you do with old Builds. Old-style
954 Builds from 0.6.4 and earlier are converted when they are first read, so the
955 first load of the Waterfall display after updating to this release may take
956 quite some time.
958 ** build process updates
960 BuildSteps can now return a status of EXCEPTION, which terminates the build
961 right away. This allows exceptions to be caught right away, but still make
962 sure the build stops quickly.
964 ** bug fixes
966 Some more windows incompatibilities were fixed. The test suite now has two
967 failing tests remaining, both of which appear to be Twisted issues that
968 should not affect normal operation.
970 The test suite no longer raises any deprecation warnings when run against
971 twisted-2.0 (except for the ones which come from Twisted itself).
974 * Release 0.6.4 (28 Apr 2005)
976 ** major bugs fixed
978 The 'buildbot' tool in 0.6.3, when used to create a new buildmaster, failed
979 unless it found a 'changes.pck' file. As this file is created by a running
980 buildmaster, this made 0.6.3 completely unusable for first-time
981 installations. This has been fixed.
983 ** minor bugs fixed
985 The IRC bot had a bug wherein asking it to watch a certain builder (the "I'll
986 give a shout when the build finishes" message) would cause an exception, so
987 it would not, in fact, shout. The HTML page had an exception in the "change
988 sources" page (reached by following the "Changes" link at the top of the
989 column that shows the names of commiters). Re-loading the config file while
990 builders were already attached would result in a benign error message. The
991 server side of the PBListener status client had an exception when providing
992 information about a non-existent Build (e.g., when the client asks for the
993 Build that is currently running, and the server says "None").
995 These bugs have all been fixed.
997 The unit tests now pass under python2.2; they were failing before because of
998 some 2.3isms that crept in. More unit tests which failed under windows now
999 pass, only one (test_webPathname_port) is still failing.
1001 ** 'buildbot' tool looks for a .buildbot/options file
1003 The 'statusgui' and the 'debugclient' subcommands can both look for a
1004 .buildbot/ directory, and an 'options' file therein, to extract default
1005 values for the location of the buildmaster. This directory is searched in the
1006 current directory, its parent, etc, all the way up to the filesystem root
1007 (assuming you own the directories in question). It also look in ~/.buildbot/
1008 for this file. This feature allows you to put a .buildbot at the top of your
1009 working tree, telling any 'buildbot' invocations you perform therein how to
1010 get to the buildmaster associated with that tree's project.
1012 Windows users get something similar, using %APPDATA%/buildbot instead of
1013 ~/.buildbot .
1015 ** windows ShellCommands are launched with 'cmd.exe'
1017 The buildslave has been modified to run all list-based ShellCommands by
1018 prepending [os.environ['COMSPEC'], '/c'] to the argv list before execution.
1019 This should allow the buildslave's PATH to be searched for commands,
1020 improving the chances that it can run the same 'trial -o foo' commands as a
1021 unix buildslave. The potential downside is that spaces in argv elements might
1022 be re-parsed, or quotes might be re-interpreted. The consensus on the mailing
1023 list was that this is a useful thing to do, but please report any problems
1024 you encounter with it.
1026 ** minor features
1028 The Waterfall display now shows the buildbot's home timezone at the top of
1029 the timestamp column. The default favicon.ico is now much nicer-looking (it
1030 is generated with Blender.. the icon.blend file is available in CVS in
1031 docs/images/ should you care to play with it).
1035 * Release 0.6.3 (25 Apr 2005)
1037 ** 'buildbot' tool gets more uses
1039 The 'buildbot' executable has acquired three new subcommands. 'buildbot
1040 debugclient' brings up the small remote-control panel that connects to a
1041 buildmaster (via the slave port and the c['debugPassword']). This tool,
1042 formerly in contrib/debugclient.py, lets you reload the config file, force
1043 builds, and simulate inbound commit messages. It requires gtk2, glade, and
1044 the python bindings for both to be installed.
1046 'buildbot statusgui' brings up a live status client, formerly available by
1047 running buildbot/clients/gtkPanes.py as a program. This connects to the PB
1048 status port that you create with:
1050   c['status'].append(client.PBListener(portnum))
1052 and shows two boxes per Builder, one for the last build, one for current
1053 activity. These boxes are updated in realtime. The effect is primitive, but
1054 is intended as an example of what's possible with the PB status interface.
1056 'buildbot statuslog' provides a text-based running log of buildmaster events.
1058 Note: command names are subject to change. These should get much more useful
1059 over time.
1061 ** web page has a favicon
1063 When constructing the html.Waterfall instance, you can provide the filename
1064 of an image that will be provided when the "favicon.ico" resource is
1065 requested. Many web browsers display this as an icon next to the URL or
1066 bookmark. A goofy little default icon is included.
1068 ** web page has CSS
1070 Thanks to Thomas Vander Stichele, the Waterfall page is now themable through
1071 CSS. The default CSS is located in buildbot/status/classic.css, and creates a
1072 page that is mostly identical to the old, non-CSS based table.
1074 You can specify a different CSS file to use by passing it as the css=
1075 argument to html.Waterfall(). See the docstring for Waterfall for some more
1076 details.
1078 ** builder "categories"
1080 Thomas has added code which places each Builder in an optional "category".
1081 The various status targets (Waterfall, IRC, MailNotifier) can accept a list
1082 of categories, and they will ignore any activity in builders outside this
1083 list. This makes it easy to create some Builders which are "experimental" or
1084 otherwise not yet ready for the world to see, or indicate that certain
1085 builders should not harass developers when their tests fail, perhaps because
1086 the build slaves for them are not yet fully functional.
1088 ** Deprecated features
1090 *** defining Builders with tuples is deprecated
1092 For a long time, the preferred way to define builders in the config file has
1093 been with a dictionary. The less-flexible old style of a 4-item tuple (name,
1094 slavename, builddir, factory) is now officially deprecated (i.e., it will
1095 emit a warning if you use it), and will be removed in the next release.
1096 Dictionaries are more flexible: additional keys like periodicBuildTime are
1097 simply unavailable to tuple-defined builders.
1099 Note: it is a good idea to watch the logfile (usually in twistd.log) when you
1100 first start the buildmaster, or whenever you reload the config file. Any
1101 warnings or errors in the config file will be found there.
1103 *** c['webPortnum'], c['webPathname'], c['irc'] are deprecated
1105 All status reporters should be defined in the c['status'] array, using
1106 buildbot.status.html.Waterfall or buildbot.status.words.IRC . These have been
1107 deprecated for a while, but this is fair warning that these keys will be
1108 removed in the next release.
1110 *** c['manholePort'] is deprecated
1112 Again, this has been deprecated for a while, in favor of:
1114  c['manhole'] = master.Manhole(port, username, password)
1116 The preferred syntax will eventually let us use other, better kinds of debug
1117 shells, such as the experimental curses-based ones in the Twisted sandbox
1118 (which would offer command-line editing and history).
1120 ** bug fixes
1122 The waterfall page has been improved a bit. A circular-reference bug in the
1123 web page's TextLog class was fixed, which caused a major memory leak in a
1124 long-running buildmaster with large logfiles that are viewed frequently.
1125 Modifying the config file in a way which only changed a builder's base
1126 directory now works correctly. The 'buildbot' command tries to create
1127 slightly more useful master/slave directories, adding a Makefile entry to
1128 re-create the .tap file, and removing global-read permissions from the files
1129 that may contain buildslave passwords.
1131 ** twisted-2.0.0 compatibility
1133 Both buildmaster and buildslave should run properly under Twisted-2.0 . There
1134 are still some warnings about deprecated functions, some of which could be
1135 fixed, but there are others that would require removing compatibility with
1136 Twisted-1.3, and I don't expect to do that until 2.0 has been out and stable
1137 for at least several months. The unit tests should pass under 2.0, whereas
1138 the previous buildbot release had tests which could hang when run against the
1139 new "trial" framework in 2.0.
1141 The Twisted-specific steps (including Trial) have been updated to match 2.0
1142 functionality.
1144 ** win32 compatibility
1146 Thankt to Nick Trout, more compatibility fixes have been incorporated,
1147 improving the chances that the unit tests will pass on windows systems. There
1148 are still some problems, and a step-by-step "running buildslaves on windows"
1149 document would be greatly appreciated.
1151 ** API docs
1153 Thanks to Thomas Vander Stichele, most of the docstrings have been converted
1154 to epydoc format. There is a utility in docs/gen-reference to turn these into
1155 a tree of cross-referenced HTML pages. Eventually these docs will be
1156 auto-generated and somehow published on the buildbot web page.
1160 * Release 0.6.2 (13 Dec 2004)
1162 ** new features
1164 It is now possible to interrupt a running build. Both the web page and the
1165 IRC bot feature 'stop build' commands, which can be used to interrupt the
1166 current BuildStep and accelerate the termination of the overall Build. The
1167 status reporting for these still leaves something to be desired (an
1168 'interrupt' event is pushed into the column, and the reason for the interrupt
1169 is added to a pseudo-logfile for the step that was stopped, but if you only
1170 look at the top-level status it appears that the build failed on its own).
1172 Builds are also halted if the connection to the buildslave is lost. On the
1173 slave side, any active commands are halted if the connection to the
1174 buildmaster is lost.
1176 ** minor new features
1178 The IRC log bot now reports ETA times in a MMSS format like "2m45s" instead
1179 of the clunky "165 seconds".
1181 ** bug fixes
1183 *** Slave Disconnect
1185 Slave disconnects should be handled better now: the current build should be
1186 abandoned properly. Earlier versions could get into weird states where the
1187 build failed to finish, clogging the builder forever (or at least until the
1188 buildmaster was restarted).
1190 In addition, there are weird network conditions which could cause a
1191 buildslave to attempt to connect twice to the same buildmaster. This can
1192 happen when the slave is sending large logfiles over a slow link, while using
1193 short keepalive timeouts. The buildmaster has been fixed to allow the second
1194 connection attempt to take precedence over the first, so that the older
1195 connection is jettisoned to make way for the newer one.
1197 In addition, the buildslave has been fixed to be less twitchy about timeouts.
1198 There are now two parameters: keepaliveInterval (which is controlled by the
1199 mktap 'keepalive' argument), and keepaliveTimeout (which requires editing the
1200 .py source to change from the default of 30 seconds). The slave expects to
1201 see *something* from the master at least once every keepaliveInterval
1202 seconds, and will try to provoke a response (by sending a keepalive request)
1203 'keepaliveTimeout' seconds before the end of this interval just in case there
1204 was no regular traffic. Any kind of traffic will qualify, including
1205 acknowledgements of normal build-status updates.
1207 The net result is that, as long as any given PB message can be sent over the
1208 wire in less than 'keepaliveTimeout' seconds, the slave should not mistakenly
1209 disconnect because of a timeout. There will be traffic on the wire at least
1210 every 'keepaliveInterval' seconds, which is what you want to pay attention to
1211 if you're trying to keep an intervening NAT box from dropping what it thinks
1212 is an abandoned connection. A quiet loss of connection will be detected
1213 within 'keepaliveInterval' seconds.
1215 *** Large Logfiles
1217 The web page rendering code has been fixed to deliver large logfiles in
1218 pieces, using a producer/consumer apparatus. This avoids the large spike in
1219 memory consumption when the log file body was linearized into a single string
1220 and then buffered in the socket's application-side transmit buffer. This
1221 should also avoid the 640k single-string limit for web.distrib servers that
1222 could be hit by large (>640k) logfiles.
1226 * Release 0.6.1 (23 Nov 2004)
1228 ** win32 improvements/bugfixes
1230 Several changes have gone in to improve portability to non-unix systems. It
1231 should be possible to run a build slave under windows without major issues
1232 (although step-by-step documentation is still greatly desired: check the
1233 mailing list for suggestions from current win32 users).
1235 *** PBChangeSource: use configurable directory separator, not os.sep
1237 The PBChangeSource, which listens on a TCP socket for change notices
1238 delivered from tools like contrib/svn_buildbot.py, was splitting source
1239 filenames with os.sep . This is inappropriate, because those file names are
1240 coming from the VC repository, not the local filesystem, and the repository
1241 host may be running a different OS (with a different separator convention)
1242 than the buildmaster host. In particular, a win32 buildmaster using a CVS
1243 repository running on a unix box would be confused.
1245 PBChangeSource now takes a sep= argument to indicate the separator character
1246 to use.
1248 *** build saving should work better
1250 windows cannot do the atomic os.rename() trick that unix can, so under win32
1251 the buildmaster falls back to save/delete-old/rename, which carries a slight
1252 risk of losing a saved build log (if the system were to crash between the
1253 delete-old and the rename).
1255 ** new features
1257 *** test-result tracking
1259 Work has begun on fine-grained test-result handling. The eventual goal is to
1260 be able to track individual tests over time, and create problem reports when
1261 a test starts failing (which then are resolved when the test starts passing
1262 again). The first step towards this is an ITestResult interface, and code in
1263 the TrialTestParser to create such results for all non-passing tests (the
1264 ones for which Trial emits exception tracebacks).
1266 These test results are currently displayed in a tree-like display in a page
1267 accessible from each Build's page (follow the numbered link in the yellow
1268 box at the start of each build to get there).
1270 This interface is still in flux, as it really wants to be able to accomodate
1271 things like compiler warnings and tests that are skipped because of missing
1272 libraries or unsupported architectures.
1274 ** bug fixes
1276 *** VC updates should survive temporary failures
1278 Some VC systems (CVS and SVN in particular) get upset when files are turned
1279 into directories or vice versa, or when repository items are moved without
1280 the knowledge of the VC system. The usual symptom is that a 'cvs update'
1281 fails where a fresh checkout succeeds.
1283 To avoid having to manually intervene, the build slaves' VC commands have
1284 been refactored to respond to update failures by deleting the tree and
1285 attempting a full checkout. This may cause some unnecessary effort when,
1286 e.g., the CVS server falls off the net, but in the normal case it will only
1287 come into play when one of these can't-cope situations arises.
1289 *** forget about an existing build when the slave detaches
1291 If the slave was lost during a build, the master did not clear the
1292 .currentBuild reference, making that builder unavailable for later builds.
1293 This has been fixed, so that losing a slave should be handled better. This
1294 area still needs some work, I think it's still possible to get both the
1295 slave and the master wedged by breaking the connection at just the right
1296 time. Eventually I want to be able to resume interrupted builds (especially
1297 when the interruption is the result of a network failure and not because the
1298 slave or the master actually died).
1300 *** large logfiles now consume less memory
1302 Build logs are stored as lists of (type,text) chunks, so that
1303 stdout/stderr/headers can be displayed differently (if they were
1304 distinguishable when they were generated: stdout and stderr are merged when
1305 usePTY=1). For multi-megabyte logfiles, a large list with many short strings
1306 could incur a large overhead. The new behavior is to merge same-type string
1307 chunks together as they are received, aiming for a chunk size of about 10kb,
1308 which should bring the overhead down to a more reasonable level.
1310 There remains an issue with actually delivering large logfiles over, say,
1311 the HTML interface. The string chunks must be merged together into a single
1312 string before delivery, which causes a spike in the memory usage when the
1313 logfile is viewed. This can also break twisted.web.distrib -type servers,
1314 where the underlying PB protocol imposes a 640k limit on the size of
1315 strings. This will be fixed (with a proper Producer/Consumer scheme) in the
1316 next release.
1319 * Release 0.6.0 (30 Sep 2004)
1321 ** new features
1323 *** /usr/bin/buildbot control tool
1325 There is now an executable named 'buildbot'. For now, this just provides a
1326 convenient front-end to mktap/twistd/kill, but eventually it will provide
1327 access to other client functionality (like the 'try' builds, and a status
1328 client). Assuming you put your buildbots in /var/lib/buildbot/master/FOO,
1329 you can do 'buildbot create-master /var/lib/buildbot/master/FOO' and it will
1330 create the .tap file and set up a sample master.cfg for you. Later,
1331 'buildbot start /var/lib/buildbot/master/FOO' will start the daemon.
1334 *** build status now saved in external files, -shutdown.tap unnecessary
1336 The status rewrite included a change to save all build status in a set of
1337 external files. These files, one per build, are put in a subdirectory of the
1338 master's basedir (named according to the 'builddir' parameter of the Builder
1339 configuration dictionary). This helps keep the buildmaster's memory
1340 consumption small: the (potentially large) build logs are kept on disk
1341 instead of in RAM. There is a small cache (2 builds per builder) kept in
1342 memory, but everything else lives on disk.
1344 The big change is that the buildmaster now keeps *all* status in these
1345 files. It is no longer necessary to preserve the buildbot-shutdown.tap file
1346 to run a persistent buildmaster. The buildmaster may be launched with
1347 'twistd -f buildbot.tap' each time, in fact the '-n' option can be added to
1348 prevent twistd from automatically creating the -shutdown.tap file.
1350 There is still one lingering bug with this change: the Expectations object
1351 for each builder (which records how long the various steps took, to provide
1352 an ETA value for the next time) is not yet saved. The result is that the
1353 first build after a restart will not provide an ETA value.
1355 0.6.0 keeps status in a single file per build, as opposed to 0.5.0 which
1356 kept status in many subdirectories (one layer for builds, another for steps,
1357 and a third for logs). 0.6.0 will detect and delete these subdirectories as
1358 it overwrites them.
1360 The saved builds are optional. To prevent disk usage from growing without
1361 bounds, you may want to set up a cron job to run 'find' and delete any which
1362 are too old. The status displays will happily survive without those saved
1363 build objects.
1365 The set of recorded Changes is kept in a similar file named 'changes.pck'.
1368 *** source checkout now uses timestamp/revision
1370 Source checkouts are now performed with an appropriate -D TIMESTAMP (for
1371 CVS) or -r REVISION (for SVN) marker to obtain the exact sources that were
1372 specified by the most recent Change going into the current Build. This
1373 avoids a race condition in which a change might be committed after the build
1374 has started but before the source checkout has completed, resulting in a
1375 mismatched set of source files. Such changes are now ignored.
1377 This works by keeping track of repository-wide revision/transaction numbers
1378 (for version control systems that offer them, like SVN). The checkout or
1379 update is performed with the highest such revision number. For CVS (which
1380 does not have them), the timestamp of each commit message is used, and a -D
1381 argument is created to place the checkout squarely in the middle of the "tree
1382 stable timer"'s window.
1384 This also provides the infrastructure for the upcoming 'try' feature. All
1385 source-checkout commands can now obtain a base revision marker and a patch
1386 from the Build, allowing certain builds to be performed on something other
1387 than the most recent sources.
1389 See source.xhtml and steps.xhtml for details.
1392 *** Darcs and Arch support added
1394 There are now build steps which retrieve a source tree from Darcs and Arch
1395 repositories. See steps.xhtml for details.
1397 Preliminary P4 support has been added, thanks to code from Dave Peticolas.
1398 You must manually set up each build slave with an appropriate P4CLIENT: all
1399 buildbot does is run 'p4 sync' at the appropriate times.
1402 *** Status reporting rewritten
1404 Status reporting was completely revamped. The config file now accepts a
1405 BuildmasterConfig['status'] entry, with a list of objects that perform status
1406 delivery. The old config file entries which controlled the web status port
1407 and the IRC bot have been deprecated in favor of adding instances to
1408 ['status']. The following status-delivery classes have been implemented, all
1409 in the 'buildbot.status' package:
1411  client.PBListener(port, username, passwd)
1412  html.Waterfall(http_port, distrib_port)
1413  mail.MailNotifier(fromaddr, mode, extraRecipients..)
1414  words.IRC(host, nick, channels)
1416 See the individual docstrings for details about how to use each one. You can
1417 create new status-delivery objects by following the interfaces found in the
1418 buildbot.interfaces module.
1421 *** BuildFactory configuration process changed
1423 The basic BuildFactory class is now defined in buildbot.process.factory
1424 rather than buildbot.process.base, so you will have to update your config
1425 files. factory.BuildFactory is the base class, which accepts a list of Steps
1426 to run. See docs/factories.xhtml for details.
1428 There are now easier-to-use BuildFactory classes for projects which use GNU
1429 Autoconf, perl's MakeMaker (CPAN), python's distutils (but no unit tests),
1430 and Twisted's Trial. Each one takes a separate 'source' Step to obtain the
1431 source tree, and then fills in the rest of the Steps for you.
1434 *** CVS/SVN VC steps unified, simplified
1436 The confusing collection of arguments for the CVS step ('clobber=',
1437 'copydir=', and 'export=') have been removed in favor of a single 'mode'
1438 argument. This argument describes how you want to use the sources: whether
1439 you want to update and compile everything in the same tree (mode='update'),
1440 or do a fresh checkout and full build each time (mode='clobber'), or
1441 something in between.
1443 The SVN (Subversion) step has been unified and accepts the same mode=
1444 parameter as CVS. New version control steps will obey the same interface.
1446 Most of the old configuration arguments have been removed. You will need to
1447 update your configuration files to use the new arguments. See
1448 docs/steps.xhtml for a description of all the new parameters.
1451 *** Preliminary Debian packaging added
1453 Thanks to the contributions of Kirill Lapshin, we can now produce .deb
1454 installer packages. These are still experimental, but they include init.d
1455 startup/shutdown scripts, which the the new /usr/bin/buildbot to invoke
1456 twistd. Create your buildmasters in /var/lib/buildbot/master/FOO, and your
1457 slaves in /var/lib/buildbot/slave/BAR, then put FOO and BAR in the
1458 appropriate places in /etc/default/buildbot . After that, the buildmasters
1459 and slaves will be started at every boot.
1461 Pre-built .debs are not yet distributed. Use 'debuild -uc -us' from the
1462 source directory to create them.
1465 ** minor features
1468 *** Source Stamps
1470 Each build now has a "source stamp" which describes what sources it used. The
1471 idea is that the sources for this particular build can be completely
1472 regenerated from the stamp. The stamp is a tuple of (revision, patch), where
1473 the revision depends on the VC system being used (for CVS it is either a
1474 revision tag like "BUILDBOT-0_5_0" or a datestamp like "2004/07/23", for
1475 Subversion it is a revision number like 11455). This must be combined with
1476 information from the Builder that is constant across all builds (something to
1477 point at the repository, and possibly a branch indicator for CVS and other VC
1478 systems that don't fold this into the repository string).
1480 The patch is an optional unified diff file, ready to be applied by running
1481 'patch -p0 <PATCH' from inside the workdir. This provides support for the
1482 'try' feature that will eventually allow developers to run buildbot tests on
1483 their code before checking it in.
1486 *** SIGHUP causes the buildmaster's configuration file to be re-read
1488 *** IRC bot now has 'watch' command
1490 You can now tell the buildbot's IRC bot to 'watch <buildername>' on a builder
1491 which is currently performing a build. When that build is finished, the
1492 buildbot will make an announcement (including the results of the build).
1494 The IRC 'force build' command will also announce when the resulting build has
1495 completed.
1498 *** the 'force build' option on HTML and IRC status targets can be disabled
1500 The html.Waterfall display and the words.IRC bot may be constructed with an
1501 allowForce=False argument, which removes the ability to force a build through
1502 these interfaces. Future versions will be able to restrict this build-forcing
1503 capability to authenticated users. The per-builder HTML page no longer
1504 displays the 'Force Build' buttons if it does not have this ability. Thanks
1505 to Fred Drake for code and design suggestions.
1508 *** master now takes 'projectName' and 'projectURL' settings
1510 These strings allow the buildbot to describe what project it is working for.
1511 At the moment they are only displayed on the Waterfall page, but in the next
1512 release they will be retrieveable from the IRC bot as well.
1515 *** survive recent (SVN) Twisted versions
1517 The buildbot should run correctly (albeit with plenty of noisy deprecation
1518 warnings) under the upcoming Twisted-2.0 release.
1521 *** work-in-progress realtime Trial results acquisition
1523 Jonathan Simms (<slyphon>) has been working on 'retrial', a rewrite of
1524 Twisted's unit test framework that will most likely be available in
1525 Twisted-2.0 . Although it is not yet complete, the buildbot will be able to
1526 use retrial in such a way that build status is reported on a per-test basis,
1527 in real time. This will be the beginning of fine-grained test tracking and
1528 Problem management, described in docs/users.xhtml .
1531 * Release 0.5.0 (22 Jul 2004)
1533 ** new features
1535 *** web.distrib servers via TCP
1537 The 'webPathname' config option, which specifies a UNIX socket on which to
1538 publish the waterfall HTML page (for use by 'mktap web -u' or equivalent),
1539 now accepts a numeric port number. This publishes the same thing via TCP,
1540 allowing the parent web server to live on a separate machine.
1542 This config option could be named better, but it will go away altogether in
1543 a few releases, when status delivery is unified. It will be replaced with a
1544 WebStatusTarget object, and the config file will simply contain a list of
1545 various kinds of status targets.
1547 *** 'master.cfg' filename is configurable
1549 The buildmaster can use a config file named something other than
1550 "master.cfg". Use the --config=foo.cfg option to mktap to control this.
1552 *** FreshCVSSource now uses newcred (CVSToys >= 1.0.10)
1554 The FreshCVSSource class now defaults to speaking to freshcvs daemons from
1555 modern CVSToys releases. If you need to use the buildbot with a daemon from
1556 CVSToys-1.0.9 or earlier, use FreshCVSSourceOldcred instead. Note that the
1557 new form only requires host/port/username/passwd: the "serviceName"
1558 parameter is no longer meaningful.
1560 *** Builders are now configured with a dictionary, not a tuple
1562 The preferred way to set up a Builder in master.cfg is to provide a
1563 dictionary with various keys, rather than a (non-extensible) 4-tuple. See
1564 docs/config.xhtml for details. The old tuple-way is still supported for now,
1565 it will probably be deprecated in the next release and removed altogether in
1566 the following one.
1568 *** .periodicBuildTime is now exposed to the config file
1570 To set a builder to run at periodic intervals, simply add a
1571 'periodicBuildTime' key to its master.cfg dictionary. Again, see
1572 docs/config.xhtml for details.
1574 *** svn_buildbot.py adds --include, --exclude
1576 The commit trigger script now gives you more control over which files are
1577 sent to the buildmaster and which are not.
1579 *** usePTY is controllable at slave mktap time
1581 The buildslaves usually run their child processes in a pty, which creates a
1582 process group for all the children, which makes it much easier to kill them
1583 all at once (i.e. if a test hangs). However this causes problems on some
1584 systems. Rather than hacking slavecommand.py to disable the use of these
1585 ptys, you can now create the slave's .tap file with --usepty=0 at mktap
1586 time.
1588 ** Twisted changes
1590 A summary of warnings (e.g. DeprecationWarnings) is provided as part of the
1591 test-case summarizer. The summarizer also counts Skips, expectedFailures,
1592 and unexpectedSuccesses, displaying the counts on the test step's event box.
1594 The RunUnitTests step now uses "trial -R twisted" instead of "trial
1595 twisted.test", which is a bit cleaner. All .pyc files are deleted before
1596 starting trial, to avoid getting tripped up by deleted .py files.
1598 ** documentation
1600 docs/config.xhtml now describes the syntax and allowed contents of the
1601 'master.cfg' configuration file.
1603 ** bugfixes
1605 Interlocks had a race condition that could cause the lock to get stuck
1606 forever.
1608 FreshCVSSource has a prefix= argument that was moderately broken (it used to
1609 only work if the prefix was a single directory component). It now works with
1610 subdirectories.
1612 The buildmaster used to complain when it saw the "info" directory in a
1613 slave's workspace. This directory is used to publish information about the
1614 slave host and its administrator, and is not a leftover build directory as
1615 the complaint suggested. This complain has been silenced.
1618 * Release 0.4.3 (30 Apr 2004)
1620 ** PBChangeSource made explicit
1622 In 0.4.2 and before, an internal interface was available which allowed
1623 special clients to inject changes into the Buildmaster. This interface is
1624 used by the contrib/svn_buildbot.py script. The interface has been extracted
1625 into a proper PBChangeSource object, which should be created in the
1626 master.cfg file just like the other kinds of ChangeSources. See
1627 docs/sources.xhtml for details.
1629 If you were implicitly using this change source (for example, if you use
1630 Subversion and the svn_buildbot.py script), you *must* add this source to
1631 your master.cfg file, or changes will not be delivered and no builds will be
1632 triggered.
1634 The PBChangeSource accepts the same "prefix" argument as all other
1635 ChangeSources. For a SVN repository that follows the recommended practice of
1636 using "trunk/" for the trunk revisions, you probably want to construct the
1637 source like this:
1639  source = PBChangeSource(prefix="trunk")
1641 to make sure that the Builders are given sensible (trunk-relative)
1642 filenames for each changed source file.
1644 ** Twisted changes
1646 *** step_twisted.RunUnitTests can change "bin/trial"
1648 The twisted RunUnitTests step was enhanced to let you run something other
1649 than "bin/trial", making it easier to use a buildbot on projects which use
1650 Twisted but aren't actually Twisted itself.
1652 *** Twisted now uses Subversion
1654 Now that Twisted has moved from CVS to SVN, the Twisted build processes have
1655 been modified to perform source checkouts from the Subversion repository.
1657 ** minor feature additions
1659 *** display Changes with HTML
1661 Changes are displayed with a bit more pizazz, and a links= argument was
1662 added to allow things like ViewCVS links to be added to the display
1663 (although it is not yet clear how this argument should be used: the
1664 interface remains subject to change untill it has been documented).
1666 *** display ShellCommand logs with HTML
1668 Headers are in blue, stderr is in red (unless usePTY=1 in which case stderr
1669 and stdout are indistinguishable). A link is provided which returns the same
1670 contents as plain text (by appending "?text=1" to the URL).
1672 *** buildslaves send real tracebacks upon error
1674 The .unsafeTracebacks option has been turned on for the buildslaves,
1675 allowing them to send a full stack trace when an exception occurs, which is
1676 logged in the buildmaster's twistd.log file. This makes it much easier to
1677 determine what went wrong on the slave side.
1679 *** BasicBuildFactory refactored
1681 The BasicBuildFactory class was refactored to make it easier to create
1682 derivative classes, in particular the BasicSVN variant.
1684 *** "ping buildslave" web button added
1686 There is now a button on the "builder information" page that lets a web user
1687 initiate a ping of the corresponding build slave (right next to the button
1688 that lets them force a build). This was added to help track down a problem
1689 with the slave keepalives.
1691 ** bugs fixed:
1693 You can now have multiple BuildSteps with the same name (the names are used
1694 as hash keys in the data structure that helps determine ETA values for each
1695 step, the new code creates unique key names if necessary to avoid
1696 collisions). This means that, for example, you do not have to create a
1697 BuildStep subclass just to have two Compile steps in the same process.
1699 If CVSToys is not installed, the tests that depend upon it are skipped.
1701 Some tests in 0.4.2 failed because of a missing set of test files, they are
1702 now included in the tarball properly.
1704 Slave keepalives should work better now in the face of silent connection
1705 loss (such as when an intervening NAT box times out the association), the
1706 connection should be reestablished in minutes instead of hours.
1708 Shell commands on the slave are invoked with an argument list instead of the
1709 ugly and error-prone split-on-spaces approach. If the ShellCommand is given
1710 a string (instead of a list), it will fall back to splitting on spaces.
1711 Shell commands should work on win32 now (using COMSPEC instead of /bin/sh).
1713 Buildslaves under w32 should theoretically work now, and one was running for
1714 the Twisted buildbot for a while until the machine had to be returned.
1716 The "header" lines in ShellCommand logs (which include the first line, that
1717 displays the command being run, and the last, which shows its exit status)
1718 are now generated by the buildslave side instead of the local (buildmaster)
1719 side. This can provide better error handling and is generally cleaner.
1720 However, if you have an old buildslave (running 0.4.2 or earlier) and a new
1721 buildmaster, then neither end will generate these header lines.
1723 CVSCommand was improved, in certain situations 0.4.2 would perform
1724 unnecessary checkouts (when an update would have sufficed). Thanks to Johan
1725 Dahlin for the patches. The status output was fixed as well, so that
1726 failures in CVS and SVN commands (such as not being able to find the 'svn'
1727 executable) make the step status box red.
1729 Subversion support was refactored to make it behave more like CVS. This is a
1730 work in progress and will be improved in the next release.
1733 * Release 0.4.2 (08 Jan 2004)
1735 ** test suite updated
1737 The test suite has been completely moved over to Twisted's "Trial"
1738 framework, and all tests now pass. To run the test suite (consisting of 64
1739 tests, probably covering about 30% of BuildBot's logic), do this:
1741  PYTHONPATH=. trial -v buildbot.test
1743 ** Mail parsers updated
1745 Several bugs in the mail-parsing code were fixed, allowing a buildmaster to
1746 be triggered by mail sent out by a CVS repository. (The Twisted Buildbot is
1747 now using this to trigger builds, as their CVS server machine is having some
1748 difficulties with FreshCVS). The FreshCVS mail format for directory
1749 additions appears to have changed recently: the new parser should handle
1750 both old and new-style messages.
1752 A parser for Bonsai commit messages (buildbot.changes.mail.parseBonsaiMail)
1753 was contributed by Stephen Davis. Thanks Stephen!
1755 ** CVS "global options" now available
1757 The CVS build step can now accept a list of "global options" to give to the
1758 cvs command. These go before the "update"/"checkout" word, and are described
1759 fully by "cvs --help-options". Two useful ones might be "-r", which causes
1760 checked-out files to be read-only, and "-R", which assumes the repository is
1761 read-only (perhaps by not attempting to write to lock files).
1764 * Release 0.4.1 (09 Dec 2003)
1766 ** MaildirSources fixed
1768 Several bugs in MaildirSource made them unusable. These have been fixed (for
1769 real this time). The Twisted buildbot is using an FCMaildirSource while they
1770 fix some FreshCVS daemon problems, which provided the encouragement for
1771 getting these bugs fixed.
1773 In addition, the use of DNotify (only available under linux) was somehow
1774 broken, possibly by changes in some recent version of Python. It appears to
1775 be working again now (against both python-2.3.3c1 and python-2.2.1).
1777 ** master.cfg can use 'basedir' variable
1779 As documented in the sample configuration file (but not actually implemented
1780 until now), a variable named 'basedir' is inserted into the namespace used
1781 by master.cfg . This can be used with something like:
1783   os.path.join(basedir, "maildir")
1785 to obtain a master-basedir-relative location.
1788 * Release 0.4.0 (05 Dec 2003)
1790 ** newapp
1792 I've moved the codebase to Twisted's new 'application' framework, which
1793 drastically cleans up service startup/shutdown just like newcred did for
1794 authorization. This is mostly an internal change, but the interface to
1795 IChangeSources was modified, so in the off chance that someone has written a
1796 custom change source, it may have to be updated to the new scheme.
1798 The most user-visible consequence of this change is that now both
1799 buildmasters and buildslaves are generated with the standard Twisted 'mktap'
1800 utility. Basic documentation is in the README file.
1802 Both buildmaster and buildslave .tap files need to be re-generated to run
1803 under the new code. I have not figured out the styles.Versioned upgrade path
1804 well enough to avoid this yet. Sorry.
1806 This also means that both buildslaves and the buildmaster require
1807 Twisted-1.1.0 or later.
1809 ** reloadable master.cfg
1811 Most aspects of a buildmaster is now controlled by a configuration file
1812 which can be re-read at runtime without losing build history. This feature
1813 makes the buildmaster *much* easier to maintain.
1815 In the previous release, you would create the buildmaster by writing a
1816 program to define the Builders and ChangeSources and such, then run it to
1817 create the .tap file. In the new release, you use 'mktap' to create the .tap
1818 file, and the only parameter you give it is the base directory to use. Each
1819 time the buildmaster starts, it will look for a file named 'master.cfg' in
1820 that directory and parse it as a python script. That script must define a
1821 dictionary named 'BuildmasterConfig' with various keys to define the
1822 builders, the known slaves, what port to use for the web server, what IRC
1823 channels to connect to, etc.
1825 This config file can be re-read at runtime, and the buildmaster will compute
1826 the differences and add/remove services as necessary. The re-reading is
1827 currently triggered through the debug port (contrib/debugclient.py is the
1828 debug port client), but future releases will add the ability to trigger the
1829 reconfiguration by IRC command, web page button, and probably a local UNIX
1830 socket (with a helper script to trigger a rebuild locally).
1832 docs/examples/twisted_master.cfg contains a sample configuration file, which
1833 also lists all the keys that can be set.
1835 There may be some bugs lurking, such as re-configuring the buildmaster while
1836 a build is running. It needs more testing.
1838 ** MaxQ support
1840 Radix contributed some support scripts to run MaxQ test scripts. MaxQ
1841 (http://maxq.tigris.org/) is a web testing tool that allows you to record
1842 HTTP sessions and play them back.
1844 ** Builders can now wait on multiple Interlocks
1846 The "Interlock" code has been enhanced to allow multiple builders to wait on
1847 each one. This was done to support the new config-file syntax for specifying
1848 Interlocks (in which each interlock is a tuple of A and [B], where A is the
1849 builder the Interlock depends upon, and [B] is a list of builders that
1850 depend upon the Interlock).
1852 "Interlock" is misnamed. In the next release it will be changed to
1853 "Dependency", because that's what it really expresses. A new class (probably
1854 called Interlock) will be created to express the notion that two builders
1855 should not run at the same time, useful when multiple builders are run on
1856 the same machine and thrashing results when several CPU- or disk- intensive
1857 compiles are done simultaneously.
1859 ** FreshCVSSource can now handle newcred-enabled FreshCVS daemons
1861 There are now two FreshCVSSource classes: FreshCVSSourceNewcred talks to
1862 newcred daemons, and FreshCVSSourceOldcred talks to oldcred ones. Mind you,
1863 FreshCVS doesn't yet do newcred, but when it does, we'll be ready.
1865 'FreshCVSSource' maps to the oldcred form for now. That will probably change
1866 when the current release of CVSToys supports newcred by default.
1868 ** usePTY=1 on posix buildslaves
1870 When a buildslave is running under POSIX (i.e. pretty much everything except
1871 windows), child processes are created with a pty instead of separate
1872 stdin/stdout/stderr pipes. This makes it more likely that a hanging build
1873 (when killed off by the timeout code) will have all its sub-childred cleaned
1874 up. Non-pty children would tend to leave subprocesses running because the
1875 buildslave was only able to kill off the top-level process (typically
1876 'make').
1878 Windows doesn't have any concept of ptys, so non-posix systems do not try to
1879 enable them.
1881 ** mail parsers should actually work now
1883 The email parsing functions (FCMaildirSource and SyncmailMaildirSource) were
1884 broken because of my confused understanding of how python class methods
1885 work. These sources should be functional now.
1887 ** more irc bot sillyness
1889 The IRC bot can now perform half of the famous AYBABTO scene.
1892 * Release 0.3.5 (19 Sep 2003)
1894 ** newcred
1896 Buildbot has moved to "newcred", a new authorization framework provided by
1897 Twisted, which is a good bit cleaner and easier to work with than the
1898 "oldcred" scheme in older versions. This causes both buildmaster and
1899 buildslaves to depend upon Twisted 1.0.7 or later. The interface to
1900 'makeApp' has changed somewhat (the multiple kinds of remote connections all
1901 use the same TCP port now).
1903 Old buildslaves will get "_PortalWrapper instance has no attribute
1904 'remote_username'" errors when they try to connect. They must be upgraded.
1906 The FreshCVSSource uses PB to connect to the CVSToys server. This has been
1907 upgraded to use newcred too. If you get errors (TODO: what do they look
1908 like?) in the log when the buildmaster tries to connect, you need to upgrade
1909 your FreshCVS service or use the 'useOldcred' argument when creating your
1910 FreshCVSSource. This is a temporary hack to allow the buildmaster to talk to
1911 oldcred CVSToys servers. Using it will trigger deprecation warnings. It will
1912 go away eventually.
1914 In conjunction with this change, makeApp() now accepts a password which can
1915 be applied to the debug service.
1917 ** new features
1919 *** "copydir" for CVS checkouts
1921 The CVS build step can now accept a "copydir" parameter, which should be a
1922 directory name like "source" or "orig". If provided, the CVS checkout is
1923 done once into this directory, then copied into the actual working directory
1924 for compilation etc. Later updates are done in place in the copydir, then
1925 the workdir is replaced with a copy.
1927 This reduces CVS bandwidth (update instead of full checkout) at the expense
1928 of twice the disk space (two copies of the tree).
1930 *** Subversion (SVN) support
1932 Radix (Christopher Armstrong) contributed early support for building
1933 Subversion-based trees. The new 'SVN' buildstep behaves roughly like the
1934 'CVS' buildstep, and the contrib/svn_buildbot.py script can be used as a
1935 checkin trigger to feed changes to a running buildmaster.
1937 ** notable bugfixes
1939 *** .tap file generation
1941 We no longer set the .tap filename, because the buildmaster/buildslave
1942 service might be added to an existing .tap file and we shouldn't presume to
1943 own the whole thing. You may want to manually rename the "buildbot.tap" file
1944 to something more meaningful (like "buildslave-bot1.tap").
1946 *** IRC reconnect
1948 If the IRC server goes away (it was restarted, or the network connection was
1949 lost), the buildmaster will now schedule a reconnect attempt.
1951 *** w32 buildslave fixes
1953 An "rm -rf" was turned into shutil.rmtree on non-posix systems.
1956 * Release 0.3.4 (28 Jul 2003)
1958 ** IRC client
1960 The buildmaster can now join a set of IRC channels and respond to simple
1961 queries about builder status.
1963 ** slave information
1965 The build slaves can now report information from a set of info/* files in
1966 the slave base directory to the buildmaster. This will be used by the slave
1967 administrator to announce details about the system hosting the slave,
1968 contact information, etc. For now, info/admin should contain the name/email
1969 of the person who is responsible for the buildslave, and info/host should
1970 describe the system hosting the build slave (OS version, CPU speed, memory,
1971 etc). The contents of these files are made available through the waterfall
1972 display.
1974 ** change notification email parsers
1976 A parser for Syncmail (syncmail.sourceforge.net) was added. SourceForge
1977 provides examples of setting up syncmail to deliver CVS commit messages to
1978 mailing lists, so hopefully this will make it easier for sourceforge-hosted
1979 projects to set up a buildbot.
1981 email processors were moved into buildbot.changes.mail . FCMaildirSource was
1982 moved, and the compatibility location (buildbot.changes.freshcvsmail) will
1983 go away in the next release.
1985 ** w32 buildslave ought to work
1987 Some non-portable code was changed to make it more likely that the
1988 buildslave will run under windows. The Twisted buildbot now has a
1989 (more-or-less) working w32 buildslave.
1992 * Release 0.3.3 (21 May 2003):
1994 ** packaging changes
1996 *** include doc/examples in the release. Oops again.
1998 ** network changes
2000 *** add keepalives to deal with NAT boxes
2002 Some NAT boxes drop port mappings if the TCP connection looks idle for too
2003 long (maybe 30 minutes?). Add application-level keepalives (dummy commands
2004 sent from slave to master every 10 minutes) to appease the NAT box and keep
2005 our connection alive. Enable this with --keepalive in the slave mktap
2006 command line. Check the README for more details.
2008 ** UI changes
2010 *** allow slaves to trigger any build that they host
2012 Added an internal function to ask the buildmaster to start one of their
2013 builds. Must be triggered with a debugger or manhole on the slave side for
2014 now, will add a better UI later.
2016 *** allow web page viewers to trigger any build
2018 Added a button to the per-build page (linked by the build names on the third
2019 row of the waterfall page) to allow viewers to manually trigger builds.
2020 There is a field for them to indicate who they are and why they are
2021 triggering the build. It is possible to abuse this, but for now the benefits
2022 outweigh the damage that could be done (worst case, someone can make your
2023 machine run builds continuously).
2025 ** generic buildprocess changes
2027 *** don't queue multiple builds for offline slaves
2029 If a slave is not online when a build is ready to run, that build is queued
2030 so the slave will run it when it next connects. However, the buildmaster
2031 used to queue every such build, so the poor slave machine would be subject
2032 to tens or hundreds of builds in a row when they finally did come online.
2033 The buildmaster has been changed to merge these multiple builds into a
2034 single one.
2036 *** bump ShellCommand default timeout to 20 minutes
2038 Used for testing out the win32 twisted builder. I will probably revert this
2039 in the next relese.
2041 *** split args in ShellCommand ourselves instead of using /bin/sh
2043 This should remove the need for /bin/sh on the slave side, improving the
2044 chances that the buildslave can run on win32.
2046 *** add configureEnv argument to Configure step, pass env dict to slave
2048 Allows build processes to do things like 'CFLAGS=-O0 ./configure' without
2049 using /bin/sh to set the environment variable
2051 ** Twisted buildprocess changes
2053 *** warn instead of flunk the build when cReactor or qtreactor tests fail
2055 These two always fail. For now, downgrade those failures to a warning
2056 (orange box instead of red).
2058 *** don't use 'clobber' on remote builds
2060 Builds that run on remote machines (freebsd, OS-X) now use 'cvs update'
2061 instead of clobbering their trees and doing a fresh checkout. The multiple
2062 simultaneous CVS checkouts were causing a strain on Glyph's upstream
2063 bandwidth.
2065 *** use trial --testmodule instead of our own test-case-name grepper
2067 The Twisted coding/testing convention has developers put 'test-case-name'
2068 tags (emacs local variables, actually) in source files to indicate which
2069 test cases should be run to exercise that code. Twisted's unit-test
2070 framework just acquired an argument to look for these tags itself. Use that
2071 instead of the extra FindUnitTestsForFiles build step we were doing before.
2072 Removes a good bit of code from buildbot and into Twisted where it really
2073 belongs.
2076 * Release 0.3.2 (07 May 2003):
2078 ** packaging changes
2080 *** fix major packaging bug: none of the buildbot/* subdirectories were
2081 included in the 0.3.1 release. Sorry, I'm still figuring out distutils
2082 here..
2084 ** internal changes
2086 *** use pb.Cacheable to update Events in remote status client. much cleaner.
2088 *** start to clean up BuildProcess->status.builder interface
2090 ** bug fixes
2092 *** waterfall display was missing a <tr>, causing it to be misrendered in most
2093 browsers (except the one I was testing it with, of course)
2095 *** URL without trailing slash (when served in a twisted-web distributed
2096 server, with a url like "http://twistedmatrix.com/~warner.twistd") should do
2097 redirect to URL-with-trailing-slash, otherwise internal hrefs are broken.
2099 *** remote status clients: forget RemoteReferences at shutdown, removes
2100 warnings about "persisting Ephemerals"
2102 ** Twisted buildprocess updates:
2104 *** match build process as of twisted-1.0.5
2105 **** use python2.2 everywhere now that twisted rejects python2.1
2106 **** look for test-result constants in multiple places
2107 *** move experimental 'trial --jelly' code to separate module
2108 *** add FreeBSD builder
2109 *** catch rc!=0 in HLint step
2110 *** remove RunUnitTestsRandomly, use randomly=1 parameter instead
2111 *** parameterize ['twisted.test'] default test case to make subclassing easier
2112 *** ignore internal distutils warnings in python2.3 builder
2115 * Release 0.3.1 (29 Apr 2003):
2117 ** First release.
2119 ** Features implemented:
2121  change notification from FreshCVS server or parsed maildir contents
2123  timed builds
2125  basic builds, configure/compile/test
2127  some Twisted-specific build steps: docs, unit tests, debuild
2129  status reporting via web page
2131 ** Features still experimental/unpolished
2133  status reporting via PB client