Skip to content

Commit 2823e9d

Browse files
committed
docs(config): document --extra-yaml as per-invocation scope
1 parent 6166142 commit 2823e9d

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

docs/config.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ Options
8686
Require at least X percent code coverage across the org following the test run.
8787
Default: 90
8888
```
89+
8990
(add-a-custom-task)=
91+
9092
### Add a Custom Task
9193

9294
To define a new task for your project, add the task name under the
@@ -648,9 +650,13 @@ You can configure files at these scope levels: _Project_, _Local
648650
Project_ and _Global_. Configurations have an order of override
649651
precedence (from highest to lowest):
650652

651-
1. Project
652-
2. Local Project
653-
3. Global
653+
1. Per-invocation (`--extra-yaml`)
654+
2. Project
655+
3. Local Project
656+
4. Global
657+
658+
Per-option overrides passed via `-o taskname__option value` on the
659+
command line take precedence over all of the above.
654660

655661
One override only cascades over another when two configurations set a
656662
value for the same element on a task or flow.
@@ -668,6 +674,16 @@ default value for `opt2`, this new default `opt2` value takes precedence
668674
over the default `opt2` value specified in your global `cumulusci.yml`
669675
file.
670676

677+
### Per-Invocation (`--extra-yaml`)
678+
679+
The `--extra-yaml PATH` flag on `cci flow run`, `cci flow info`,
680+
`cci task run`, and `cci task info` merges an additional YAML file
681+
into the project config for a single command invocation. Multiple
682+
files are deep-merged in order (later files win); the
683+
`CUMULUSCI_EXTRA_YAML` environment variable (colon-separated paths)
684+
is honored as a fallback. See [the CLI reference](cli.md#the-extra-yaml-flag)
685+
for usage and security implications.
686+
671687
### Project Configurations
672688

673689
**macOS/Linux:** `.../path/to/project/cumulusci.yml`

0 commit comments

Comments
 (0)