Opened 5 years ago

Last modified 4 years ago

#2494 new enhancement

Clarify and document the default values for haltOnFailures, flunkOnWarnings, warnOnFailures, etc.

Reported by: johnt Owned by:
Priority: major Milestone: 0.9.+
Version: 0.8.7p1 Keywords: docs sprint simple
Cc:

Description

In cases where build steps fail or have warnings it is not always immediately clear what will happen to the build - will it stop or continue and what will it be marked as?

To this end it might be a good idea to provide this information in a table in the documentation. It could contain a list of the possible build steps which have parameters set by default and possibly a link to the API reference. Example:

Buildstep | Default Parameters | API ref

Configure | haltOnFailures=True, flunkOnFailures=True | Link

Compile | haltOnFailures=True, flunkOnFailures=True | Link

ShellCommand? | flunkOnFailures=True | Link

...

This would make it clear to users why their builder is behaving as it is.

Change History (6)

comment:1 Changed 5 years ago by johnt

  • Priority changed from minor to major
  • Summary changed from It is not always clear what parameters each buildstep can have which can result in unexpected behavior to Clarify and document the default vaules for haltOnFailures, flunkOnWarnings, warnOnFailures, etc.

comment:2 Changed 5 years ago by johnt

A good example of this is that Compile() and Configure() have haltOnFailures set to True by default but shellCommand() has it set to False

comment:3 Changed 5 years ago by johnt

Example documentation:

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:

ParameterResult
haltOnFailuresHalt if this step fails (except stems which are makred as alwaysRun=True)
flunkOnWarningsWarnings or failure in this step will mark the build as Failed
flunkOnFailureFailure in this step will mark the build as Failed
warnOnWarningsWarnings or failure in this step will mark the build as Warnings
warnOnFailureFailure in this step will mark the build as Failed
alwaysRunAlways 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:

BuildstepParametersAPI ref
ConfigurehaltOnFailures=True, flunkOnFailures=Truelink
CompilehaltOnFailures=True, flunkOnFailures=Truelink
ShellCommand?flunkOnFailures=Truelink
RemoveDir?haltOnFailures=True, flunkOnFailures=Truelink
SetProperty? link
MasterShellCommand?haltOnFailures=True, flunkOnFailures=Truelink
Git link
DirectoryUpload? link
Last edited 5 years ago by johnt (previous) (diff)

comment:4 Changed 5 years ago by dustin

  • Keywords sprint simple added; steps parameters api removed
  • Milestone changed from undecided to 0.8.+

comment:5 Changed 5 years ago by ewong

  • Summary changed from Clarify and document the default vaules for haltOnFailures, flunkOnWarnings, warnOnFailures, etc. to Clarify and document the default values for haltOnFailures, flunkOnWarnings, warnOnFailures, etc.

comment:6 Changed 4 years ago by dustin

  • Milestone changed from 0.8.+ to 0.9.+

Ticket retargeted after milestone closed

Note: See TracTickets for help on using tickets.