Perform multiple includes at the same scope level #732

New Issue

witten · 2023-07-24T04:04:51Z

witten commented

2023-07-24 04:04:51 +00:00

What I'd like to do and why

In more complex borgmatic configurations, it's not uncommon for a single configuration file to pull in multiple includes for purposes of option reuse. Prior to #721 (removal of config sections), users often did that reuse at the level of one include per configuration section. However, with sections deprecated now (and ultimately going away), that include scope is no longer really available. Which leads to the logical next step of doing those includes at global scope. However, due to a YAML limitation, a single scope can't have multiple "<<:" keys and therefore multiple global includes don't work.

As a solution to this problem, I propose simply allowing multiple file includes in a single include statement. For instance, maybe something like this:

<<: !include [common1.yaml, common2.yaml, common3.yaml]

And this (both supported):

<<: !include
    - common1.yaml
    - common2.yaml
    - common3.yaml

That should work around the YAML limitation and allow the user to perform multiple includes—even if they're all at the same scope.

Other notes / implementation ideas

It would probably make sense for the listed includes to be included/applied in listed order, such that the final include overrides the previous ones.

### What I'd like to do and why In more complex borgmatic configurations, it's not uncommon for a single configuration file to pull in multiple includes for purposes of option reuse. Prior to #721 (removal of config sections), users often did that reuse at the level of one include per configuration section. However, with sections deprecated now (and ultimately going away), that include scope is no longer really available. Which leads to the logical next step of doing those includes at global scope. However, due to a YAML limitation, a single scope can't have multiple "<<:" keys and therefore multiple global includes don't work. As a solution to this problem, I propose simply allowing multiple file includes in a single include statement. For instance, maybe something like this: ```python <<: !include [common1.yaml, common2.yaml, common3.yaml] ``` And this (both supported): ```python <<: !include - common1.yaml - common2.yaml - common3.yaml ``` That should work around the YAML limitation and allow the user to perform multiple includes—even if they're all at the same scope. ### Other notes / implementation ideas It would probably make sense for the listed includes to be included/applied in listed order, such that the final include overrides the previous ones.

🚀 2

witten referenced this issue

2023-07-24 04:07:02 +00:00

Remove configuration sections entirely (except for deprecated support) #721

witten referenced this issue from a commit

2023-08-01 21:13:12 +00:00

Multiple configuration includes with a single "!include" (#732).

witten referenced this issue

2023-08-01 21:36:44 +00:00

Include multiple configuration files with a single "!include" (#732). #737

witten referenced this issue from a commit

2023-08-01 23:28:06 +00:00