Radish alpha
r
radicle-ci-broker
rad:zwTxygwuz5LDGBq255RA2CbNGrz8
Radicle CI broker
Radicle
Git
Commits › 9d218bd
doc(doc/userguide.md): document configuration file fields
Lars Wirzenius committed 9 months ago
commit 9d218bd92f605ec6d5f2b70ecad8c1d06be5af0e
parent 05283ad
1 file changed +29 -13
modified doc/userguide.md
@@ -280,19 +280,35 @@ The output will be in JSON (which also works as YAML input):


The configuration fields are:
- 
| field | summary |
- 
|:------|:--------|
- 
| `adapters` | list of CI adapters |
- 
| `concurrent_adapters` | max number of adapters to run at the same time |
- 
| `db` | database |
- 
| `default_adapter` |  this will become deprecated, use `triggers` instead |
- 
| `filters` | this will become deprecated, use `triggers` instead |
- 
| `max_run_time` | maximum duration of a CI run |
- 
| `queue_len_interval` | how often the event queue length should be logged |
- 
| `report_dir` | directory where HTML and JSON report pages are written |
- 
| `status_update_interval_seconds` | how often should `status.json` be updated? |
- 
| `triggers` | see [the "Triggering CI" chapter](#triggers) |
-
+ 
| field                            | summary                                                |
+ 
|:---------------------------------|:-------------------------------------------------------|
+ 
| `adapters`                       | list of CI adapters                                    |
+ 
| `concurrent_adapters`            | max number of adapters to run at the same time         |
+ 
| `db`                             | database                                               |
+ 
| `default_adapter`                | this will become deprecated, use `triggers` instead    |
+ 
| `filters`                        | this will become deprecated, use `triggers` instead    |
+ 
| `max_run_time`                   | maximum duration of a CI run                           |
+ 
| `queue_len_interval`             | how often the event queue length should be logged      |
+ 
| `report_dir`                     | directory where HTML and JSON report pages are written |
+ 
| `status_update_interval_seconds` | how often should `status.json` be updated?             |
+ 
| `triggers`                       | see [the "Triggering CI" chapter](#triggers)           |
+
+ 
The items in the `adapters` list may use the following fields:
+
+ 
| field           | summary                                                                            |
+ 
|:----------------|:-----------------------------------------------------------------------------------|
+ 
| `command`       | name of command to run                                                             |
+ 
| `env`           | optional; a key/value map of environment variables to add when running the adapter |
+ 
| `sensitive_env` | optional; like `env`, but value are never logged                                   |
+ 
| `config`        | optional; a key/value map to configure the adapter                                 |
+ 
| `config_env`    | optional; name of environment variable for adapter configuration from `config      |
+
+ 
The `config` and `config_env` fields allow embedding configuration
+ 
values for the adapter. The CI broker will write the values in
+ 
`config` to a temporary file, as YAML, and set the environment
+ 
variable named in `config_env` to the path to the temporary file. This
+ 
can reduce the number of files needed to be maintained to configure
+ 
`cib` and all the adapters.





# CI events