diff doc/recipes.txt @ 754:545be0c8f405

Adding the ability to modify the default ''onerror'' property in the ''<build>'' element. If not specified, the behavior is unchanged; by default any step failure will result in the build failing and stopping. Added a new ''continue'' onerror specification-- it's similar to ''ignore'' except the results of ''continue'' steps are counted in the overall build status (in ''ignore'' they're ignored.) You'll need to upgrade both your master and slaves if you wish to use the ''<build>'' element override or the new ''continue'' value. Will update http://bitten.edgewall.org/wiki/Documentation/recipes.html . Thanks to jerith for comments. Closes #409. Refs #210.
author wbell
date Sat, 24 Apr 2010 13:37:26 +0000
parents 94a4be5a1f0f
children 025b3e889321
line wrap: on
line diff
--- a/doc/recipes.txt
+++ b/doc/recipes.txt
@@ -36,9 +36,19 @@
 these elements are declared in XML namespaces, where the namespace URI defines
 a collection of related commands.
 
-A ``<step>`` element can additionally have an ``onerror`` attribute with
-value of ``fail`` (terminate after step, default behaviour) or ``ignore``
-(fail, but run next step).
+
+The ``<build>`` element can optionally have an ``onerror`` attribute that
+dictates how a build should proceed after the failure of a step. Allowable
+values are:
+  ``fail``: failure of a step causes the build to terminate. (default)
+  ``continue``: builds continue after step failures. Failing steps
+                contribute to the overall build status.
+  ``ignore``: builds continue after step failures. Builds are marked
+              as successful even in the presence of failed steps with
+	      onerror='ignore'
+
+``<step>`` elements can override the ``<build>`` ``onerror`` attribute with
+their own ``onerror`` attributes.
 
 Commonly, the first step of any build recipe will perform the checkout from the
 repository.
Copyright (C) 2012-2017 Edgewall Software