Add support for --load-yml to cci task and cci flow commands #3725
Conversation
including full test coverage and docs.
| @@ -0,0 +1,14 @@ | |||
| flows: | |||
There was a problem hiding this comment.
Perhaps this belongs alongside the tests instead of here?
There was a problem hiding this comment.
Yeah, I suggest adding it inline in the tests and using tmp_path to write the contents to disk during the test. If that's not workable, then moving it to the same subdirectory as the tests is fine.
| @@ -0,0 +1,14 @@ | |||
| flows: | |||
There was a problem hiding this comment.
Yeah, I suggest adding it inline in the tests and using tmp_path to write the contents to disk during the test. If that's not workable, then moving it to the same subdirectory as the tests is fine.
|
|
||
| ## Loading additional yaml configuration from a file | ||
|
|
||
| CumulusCI supports loading in an additional yaml file from the command line with the `--load-yml <path/to/file>` option on `cci task` and `cci flow` commands. This can be useful if you have one-off automation configurations that you want to keep out of the main project's configuration and load only in special cases. |
There was a problem hiding this comment.
Thanks for including documentation with your PR. I think that there should be a mention of this option in the configuration scopes section above.
There was a problem hiding this comment.
Thanks for the review. I'll get these addressed shortly.
|
Fixes #3429. |
|
@jlantz Following up on this PR. |
|
I will get those two changes done and submitted this week, along with a whole bunch of new stuff to put in the review queue ;) |
The BaseCumulusCI runtime has long had support for passing additional_yaml which is then added to the yaml merge stack. This functionality was used extensively in MetaCI to inject build specific configuration overrides for certain build plans. However, it was never exposed to the cci cli.
This PR adds a new
--load-yml <path/to/additional.yml>option flag for all subcommands ofcci taskandcci flowby adding support for the option in the main command and then implementing it as an option for the cci task and cci flow commands.This change should have no impact on existing users and is purely additive functionality that didn't exist before. I've added a docs section to the config docs explaining the use case which is included with this PR along with full test coverage.