Skip to content

Commit 6166142

Browse files
committed
docs(cli): document --extra-yaml flag and CUMULUSCI_EXTRA_YAML
1 parent 7d0c39e commit 6166142

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

docs/cli.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,35 @@ All CumulusCI commands can be passed the `--debug` flag, so that:
480480
To exit a debugging session, type the command `quit` or `exit`.
481481
```
482482

483+
### The `--extra-yaml` Flag
484+
485+
`cci flow run`, `cci flow info`, `cci task run`, and `cci task info`
486+
accept a `--extra-yaml PATH` option that merges an additional YAML file
487+
into the project config for that single command. The flag can be
488+
repeated; later files override earlier ones via deep merge.
489+
490+
```console
491+
$ cci task run my_task --extra-yaml migrations/v2.yml
492+
$ cci flow run dev_org --extra-yaml base.yml --extra-yaml override.yml
493+
```
494+
495+
The `CUMULUSCI_EXTRA_YAML` environment variable (colon-separated paths)
496+
supplies a default when the flag is absent. When both are set, the flag
497+
wins; they are not merged.
498+
499+
Extra YAML is merged using the same deep-merge semantics as the project
500+
`cumulusci.yml`. Mappings and scalars are overridden; lists are
501+
concatenated, not replaced. See
502+
[Configuration Scopes](config.md#configuration-scopes) for details.
503+
Per-option overrides via `-o taskname__option value` still win over
504+
extra YAML.
505+
506+
```{warning}
507+
Extra YAML can redefine any `class_path` entry and therefore trigger
508+
arbitrary Python imports when the task runs. Only load files you trust.
509+
A stderr warning is printed each time the flag is used.
510+
```
511+
483512
### Log Files
484513

485514
CumulusCI creates a log file every time a cci command runs. There are

0 commit comments

Comments
 (0)