[Buildbot-commits] [Buildbot] #2494: Clarify and document the default vaules for haltOnFailures, flunkOnWarnings, warnOnFailures, etc.

[Buildbot trac]

#2494: Clarify and document the default vaules for haltOnFailures,
flunkOnWarnings, warnOnFailures, etc.
--------------------------------------+------------------------
Reporter:  johnt                      |       Owner:
    Type:  enhancement                |      Status:  new
Priority:  major                      |   Milestone:  undecided
 Version:  0.8.7p1                    |  Resolution:
Keywords:  docs steps parameters api  |
--------------------------------------+------------------------

Comment (by johnt):

 Buildbot allows the use of a number of parameters for every buildstep
 which control how that step will behave in the case of warnings or errors
 being generated. Most steps can be successful (green), fail (red), have an
 exception such as incorrect buildbot code (purple), be skipped (blue) or
 in some cases generate warnings (orange). In general, if all steps succeed
 in a build (even if there are warnings) that build will be marked as
 successful (green). The following table shows the parameters which can be
 set to control how a builder will behave in some of these circumstances:

 ||Parameter||Result||
 ||haltOnFailures||Halt if this step fails (except stems which are makred
 as alwaysRun=True)||
 ||flunkOnWarnings||Warnings or failure in this step will mark the build as
 Failed||
 ||flunkOnFailure||Failure in this step will mark the build as Failed||
 ||warnOnWarnings||Warnings or failure in this step will mark the build as
 Warnings||
 ||warnOnFailure||Failure in this step will mark the build as Failed||
 ||alwaysRun||Always run this buildstep - this can be used for cleanup
 code||

 Some types of buildsteps have default parameters which are different from
 the normal settings and can cause unexpected behavior:

 ||Buildstep||Parameters||API ref||
 ||Configure||haltOnFailures=True,
 flunkOnFailures=True||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.shell
 .Configure-class.html link]||
 ||Compile||haltOnFailures=True,
 flunkOnFailures=True||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.shell
 .Compile-class.html link]||
 ||ShellCommand||flunkOnFailures=True||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.shell
 .ShellCommand-class.html link]||
 ||RemoveDir||haltOnFailures=True,
 flunkOnFailures=True||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.slave
 .RemoveDirectory-class.html link]||
 ||SetProperty||
 ||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.shell
 .SetProperty-class.html link]||
 ||MasterShellCommand||haltOnFailures=True,
 flunkOnFailures=True||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.master
 .MasterShellCommand-class.html link]||
 ||Git||
 ||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.source.git
 .Git-class.html link]||
 ||DirectoryUpload||
 ||[http://docs.buildbot.net/0.8.6p1/reference/buildbot.steps.transfer
 .DirectoryUpload-class.html link]||

-- 
Ticket URL: <http://trac.buildbot.net/ticket/2494#comment:3>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation