<html lang="en">
<head>
<title>SingleBranchScheduler - BuildBot Manual - 0.8.4p1</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="BuildBot Manual - 0.8.4p1">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Schedulers.html#Schedulers" title="Schedulers">
<link rel="prev" href="Change-Filters.html#Change-Filters" title="Change Filters">
<link rel="next" href="AnyBranchScheduler.html#AnyBranchScheduler" title="AnyBranchScheduler">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This is the BuildBot manual for Buildbot version 0.8.4p1.
Copyright (C) 2005, 2006, 2009, 2010 Brian Warner
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="SingleBranchScheduler"></a>
<p>
Next: <a rel="next" accesskey="n" href="AnyBranchScheduler.html#AnyBranchScheduler">AnyBranchScheduler</a>,
Previous: <a rel="previous" accesskey="p" href="Change-Filters.html#Change-Filters">Change Filters</a>,
Up: <a rel="up" accesskey="u" href="Schedulers.html#Schedulers">Schedulers</a>
<hr>
</div>
<h4 class="subsection">4.8.3 SingleBranchScheduler</h4>
<p><a name="index-buildbot_002eschedulers_002ebasic_002eSingleBranchScheduler-53"></a>
This is the original and still most popular scheduler class. It follows
exactly one branch, and starts a configurable tree-stable-timer after
each change on that branch. When the timer expires, it starts a build
on some set of Builders. The scheduler accepts a <code>fileIsImportant</code>
function which can be used to ignore some Changes if they do not
affect any “important” files.
<p>The arguments to this scheduler are:
<dl>
<dt><code>name</code>
<br><dt><code>builderNames</code>
<br><dt><code>properties</code>
<br><dt><code>fileIsImportant</code>
<br><dt><code>change_filter</code><dd>see <a href="Configuring-Schedulers.html#Configuring-Schedulers">Configuring Schedulers</a>
<br><dt><code>treeStableTimer</code><dd>The scheduler will wait for this many seconds before starting the
build. If new changes are made during this interval, the timer will be
restarted, so really the build will be started after a change and then
after this many seconds of inactivity.
<p>If treeStableTimer is <code>None</code>, then a separate build is started
immediately for each Change.
<br><dt><code>categories (deprecated; use change_filter)</code><dd>A list of categories of changes that this scheduler will respond to. If this
is specified, then any non-matching changes are ignored.
<br><dt><code>branch (deprecated; use change_filter)</code><dd>The scheduler will pay attention to this branch, ignoring Changes that occur
on other branches. Setting <code>branch</code> equal to the special value of
<code>None</code> means it should only pay attention to the default branch. Note that
<code>None</code> is a keyword, not a string, so write <code>None</code> and not
<code>"None"</code>.
</dl>
<p>Example:
<pre class="example"> from buildbot.schedulers.basic import SingleBranchScheduler
quick = SingleBranchScheduler(name="quick",
branch=None,
treeStableTimer=60,
builderNames=["quick-linux", "quick-netbsd"])
full = SingleBranchScheduler(name="full",
branch=None,
treeStableTimer=5*60,
builderNames=["full-linux", "full-netbsd", "full-OSX"])
c['schedulers'] = [quick, full]
</pre>
<p>In this example, the two “quick” builders are triggered 60 seconds
after the tree has been changed. The “full” builds do not run quite
so quickly (they wait 5 minutes), so hopefully if the quick builds
fail due to a missing file or really simple typo, the developer can
discover and fix the problem before the full builds are started. Both
Schedulers only pay attention to the default branch: any changes
on other branches are ignored by these schedulers. Each scheduler
triggers a different set of Builders, referenced by name.
<p><a name="index-buildbot_002eschedulers_002ebasic_002eScheduler-54"></a><a name="index-buildbot_002escheduler_002eScheduler-55"></a>The old names for this scheduler, <code>buildbot.scheduler.Scheduler</code> and
<code>buildbot.schedulers.basic.Scheduler</code>, are deprecated in favor of the more
accurate name <code>SingleBranchScheduler</code>.
</body></html>
