commit 8bafaafdaae234458a167af19d9930e95fc42567 parent 6953a4784fa29ddbb3e4afc9808b661c5c2b5561 Author: Stefan Koch <programming@stefan-koch.name> Date: Sun, 3 May 2020 11:06:28 +0200 clarify which configuration files we have Diffstat:
| M | README.md | | | 18 | ++++++++++++++++++ |
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -51,6 +51,24 @@ cinderella run https://github.com/aufziehvogel/Cinderella.git --file /home/user/ ``` +Configuration Files +------------------- + +Cinderella uses two configuration files: + +- **CI Configuration File**: The CI configuration file is usually called + `.cinderella.toml` and belongs to the project + that should be built. It defines under which circumstances Cinderella should + build the project (e.g. only tags, only specific branches) and which + commands the Cinderella engine has to execute to run the build. Without + this file, Cinderella will not run a build for the project. +- **Cinderella Configuration File**: The Cinderella configuration file belongs + to your Cinderella instance. It is usually called `config.toml` and is + located in the same folder as your Cinderella executable. It specifies + parameters that Cinderella needs to perform actions like sending e-mails, + writing output files or decrypting secrets. This file is optional. + + CI Configuration Format -----------------------