4.12.1 Common Parameters

All BuildSteps accept some common parameters. Some of these control
how their individual status affects the overall build. Others are used
to specify which Locks (see see Interlocks) should be
acquired before allowing the step to run.

Arguments common to all BuildStep subclasses:

name

the name used to describe the step on the status display. It is also
used to give a name to any LogFiles created by this step.

haltOnFailure

if True, a FAILURE of this build step will cause the build to halt
immediately. Steps with alwaysRun=True are still run. Generally
speaking, haltOnFailure implies flunkOnFailure (the default for most
BuildSteps). In some cases, particularly series of tests, it makes sense
to haltOnFailure if something fails early on but not flunkOnFailure.
This can be achieved with haltOnFailure=True, flunkOnFailure=False.

flunkOnWarnings

when True, a WARNINGS or FAILURE of this build step will mark the
overall build as FAILURE. The remaining steps will still be executed.

flunkOnFailure

when True, a FAILURE of this build step will mark the overall build as
a FAILURE. The remaining steps will still be executed.

warnOnWarnings

when True, a WARNINGS of this build step will mark the
overall build as having WARNINGS. The remaining steps will still be
executed.

warnOnFailure

when True, a FAILURE of this build step will mark the overall build as
having WARNINGS. The remaining steps will still be executed.

alwaysRun

if True, this build step will always be run, even if a previous buildstep
with haltOnFailure=True has failed.

doStepIf

A step can be configured to only run under certain conditions. To do this, set
the step's doStepIf to a boolean value, or to a function that returns a
boolean value or Deferred. If the value or function result is false, then the
step will return SKIPPED without doing anything. Oherwise, the step will be
executed normally. If you set doStepIf to a function, that function
should accept one parameter, which will be the Step object itself.

locks

a list of Locks (instances of buildbot.locks.SlaveLock or
buildbot.locks.MasterLock) that should be acquired before starting this
Step. The Locks will be released when the step is complete. Note that this is a
list of actual Lock instances, not names. Also note that all Locks must have
unique names. See Interlocks.