commit 6849c3628f499ef2ae42d84034ee502fef4cd89c parent 7386e6ce8c70dd5f643fed651e9ce918b606df31 Author: Stefan Koch <programming@stefan-koch.name> Date: Sun, 8 Dec 2019 21:17:00 +0100 improve CI configuration format section of docs Diffstat:
| M | README.md | | | 7 | +++++-- |
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md @@ -39,7 +39,9 @@ cinderella run https://github.com/aufziehvogel/Cinderella.git --file /home/user/ CI Configuration Format ----------------------- -The *CI configuration file* is a TOML file with one table per build pipeline. +The *CI configuration file* has to be saved to the root directory of your +repository as `.cinderella.toml`. +It is a TOML file with one table per build pipeline. Common build pipelines are `test` or `build`. E.g. the following is a valid configuration file executing a `test` phase and a `build-release` phase. @@ -61,7 +63,8 @@ desired shell manually. Pipelines are executed in the order in which they are defined. For the given configuration file it is ensured that first `test` is being executed -followed by `build-release`. +followed by `build-release`. If an error occurs in any of the pipelines, +execution will be aborted and the following pipelines will not be executed. ### Variables