Mercurial > bitten > bitten-test
comparison doc/recipes.txt @ 611:294641e84e89
0.6dev: Adding `${name}` and `${basedir}` (#325) for recipe substitution. Updated docs + new test.
| author | osimons |
|---|---|
| date | Sat, 01 Aug 2009 01:56:14 +0000 |
| parents | b76e6accad72 |
| children | 7a8ddf54f012 |
comparison
equal
deleted
inserted
replaced
| 610:610a97f7e1ba | 611:294641e84e89 |
|---|---|
| 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 | 39 A ``<step>`` element can additionally have an ``onerror`` attribute with |
| 40 values of ``fail`` (terminate after step, default behaviour), or ``continue`` | 40 value of ``fail`` (terminate after step, default behaviour) or ``ignore`` |
| 41 (fail, but run next step), or ``ignore`` (errors are unimportant, continue). | 41 (fail, but run next step). |
| 42 | 42 |
| 43 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 |
| 44 repository. | 44 repository. |
| 45 | 45 |
| 46 .. code-block:: xml | 46 .. code-block:: xml |
| 73 | 73 |
| 74 Recipes supports variables that can be interpolated into recipes, and using | 74 Recipes supports variables that can be interpolated into recipes, and using |
| 75 `Slave Configuration`_ further custom properties can be used. Bitten supports | 75 `Slave Configuration`_ further custom properties can be used. Bitten supports |
| 76 these pre-defined properties: | 76 these pre-defined properties: |
| 77 | 77 |
| 78 .. _`slave configuration`: slaveconfig.html | 78 .. _`slave configuration`: configure.html |
| 79 | 79 |
| 80 +-----------------+----------------------------------------------------------+ | 80 +-----------------+----------------------------------------------------------+ |
| 81 | Constant | Value | | 81 | Constant | Value | |
| 82 +=================+==========================================================+ | 82 +=================+==========================================================+ |
| 83 | ``${path}`` | Repository path from the build configuration | | 83 | ``${path}`` | Repository path from the build configuration | |
| 85 | ``${config}`` | The build configuration name | | 85 | ``${config}`` | The build configuration name | |
| 86 +-----------------+----------------------------------------------------------+ | 86 +-----------------+----------------------------------------------------------+ |
| 87 | ``${build}`` | The index of this build request | | 87 | ``${build}`` | The index of this build request | |
| 88 +-----------------+----------------------------------------------------------+ | 88 +-----------------+----------------------------------------------------------+ |
| 89 | ``${revision}`` | The repository revision being tested | | 89 | ``${revision}`` | The repository revision being tested | |
| 90 +-----------------+----------------------------------------------------------+ | |
| 91 | ``${platform}`` | The name of the target platform being built | | |
| 92 +-----------------+----------------------------------------------------------+ | |
| 93 | ``${name}`` | The name of the build slave | | |
| 94 +-----------------+----------------------------------------------------------+ | |
| 95 | ``${basedir}`` | The absolute path of the build location, joining | | |
| 96 | | ``work-dir`` (absolute) with ``build-dir`` (relative) | | |
| 90 +-----------------+----------------------------------------------------------+ | 97 +-----------------+----------------------------------------------------------+ |
| 91 | 98 |
| 92 As the recipe needs to be valid XML, any reserved characters in attributes must | 99 As the recipe needs to be valid XML, any reserved characters in attributes must |
| 93 be quoted using regular XML entities: | 100 be quoted using regular XML entities: |
| 94 | 101 |