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
alwaysRun=Trueare 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.
doStepIfto 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
doStepIfto a function, that function should accept one parameter, which will be the
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.