Mercurial > bitten > bitten-test
comparison doc/recipes.txt @ 599:b76e6accad72
0.6dev: Added Configuration documentation. It contains all configuration information I've found in the wiki and source code.
| author | osimons |
|---|---|
| date | Thu, 30 Jul 2009 09:47:48 +0000 |
| parents | ba53929c8652 |
| children | 294641e84e89 |
comparison
equal
deleted
inserted
replaced
| 598:5f3e66e5b451 | 599:b76e6accad72 |
|---|---|
| 34 | 34 |
| 35 A ``<step>`` element will consist of any number of commands and reports. Most of | 35 A ``<step>`` element will consist of any number of commands and reports. Most of |
| 36 these elements are declared in XML namespaces, where the namespace URI defines | 36 these elements are declared in XML namespaces, where the namespace URI defines |
| 37 a collection of related commands. | 37 a collection of related commands. |
| 38 | 38 |
| 39 A ``<step>```element can additionally have a ``onerror`` attribute with possible | |
| 40 values of ``fail`` (terminate after step, default behaviour), or ``continue`` | |
| 41 (fail, but run next step), or ``ignore`` (errors are unimportant, continue). | |
| 42 | |
| 39 Commonly, the first step of any build recipe will perform the checkout from the | 43 Commonly, the first step of any build recipe will perform the checkout from the |
| 40 repository. | 44 repository. |
| 41 | 45 |
| 42 .. code-block:: xml | 46 .. code-block:: xml |
| 43 | 47 |
| 65 See `Build Recipe Commands`_ for a comprehensive reference of the commands | 69 See `Build Recipe Commands`_ for a comprehensive reference of the commands |
| 66 available by default. | 70 available by default. |
| 67 | 71 |
| 68 .. _`build recipe commands`: commands.html | 72 .. _`build recipe commands`: commands.html |
| 69 | 73 |
| 74 Recipes supports variables that can be interpolated into recipes, and using | |
| 75 `Slave Configuration`_ further custom properties can be used. Bitten supports | |
| 76 these pre-defined properties: | |
| 77 | |
| 78 .. _`slave configuration`: slaveconfig.html | |
| 79 | |
| 80 +-----------------+----------------------------------------------------------+ | |
| 81 | Constant | Value | | |
| 82 +=================+==========================================================+ | |
| 83 | ``${path}`` | Repository path from the build configuration | | |
| 84 +-----------------+----------------------------------------------------------+ | |
| 85 | ``${config}`` | The build configuration name | | |
| 86 +-----------------+----------------------------------------------------------+ | |
| 87 | ``${build}`` | The index of this build request | | |
| 88 +-----------------+----------------------------------------------------------+ | |
| 89 | ``${revision}`` | The repository revision being tested | | |
| 90 +-----------------+----------------------------------------------------------+ | |
| 91 | |
| 70 As the recipe needs to be valid XML, any reserved characters in attributes must | 92 As the recipe needs to be valid XML, any reserved characters in attributes must |
| 71 be quoted using regular XML entities: | 93 be quoted using regular XML entities: |
| 72 | 94 |
| 73 +-----------+------------+ | 95 +-----------+------------+ |
| 74 | Character | Quoted | | 96 | Character | Quoted | |