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