Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122). #1144

Merged

witten merged 4 commits from check-runtime-directory-excludes into main

2025-09-13 05:40:05 +00:00

witten commented

2025-09-12 18:26:07 +00:00

Owner

Implementation of #1122. To prevent the user from inadvertently excluding the bootstrap action's manifest from a backup archive—thereby preventing the bootstrap action from working—this PR now always errors and exits when the borgmatic runtime directory overlaps with the configured excludes. Previously, this check was only performed when database streaming was in use. Now, the check is performed all the time.

In terms of implementation, this check runs a borg create --dry-run to get the list of individual file paths that Borg plans to backup and compares that list against the borgmatic runtime directory to see if it has been excluded.

Considerations

In practice, this is a performance hit, because the dry-run isn't free. However, this is apparently the cost of protecting the user from accidentally breaking bootstrapping or other (current or future) features that rely on the borgmatic runtime directory getting backed up.

Still to do

automated tests
account for the case where store_config_files: false and the runtime directory never gets added to patterns to begin with

Implementation of #1122. To prevent the user from inadvertently excluding the `bootstrap` action's manifest from a backup archive—thereby preventing the `bootstrap` action from working—this PR now always errors and exits when the borgmatic runtime directory overlaps with the configured excludes. Previously, this check was only performed when database streaming was in use. Now, the check is performed all the time. In terms of implementation, this check runs a `borg create --dry-run` to get the list of individual file paths that Borg plans to backup and compares that list against the borgmatic runtime directory to see if it has been excluded. ### Considerations In practice, this is a performance hit, because the dry-run isn't free. However, this is apparently the cost of protecting the user from accidentally breaking bootstrapping or other (current or future) features that rely on the borgmatic runtime directory getting backed up. ### Still to do * [x] automated tests * [x] account for the case where `store_config_files: false` and the runtime directory never gets added to `patterns` to begin with

witten added 1 commit

2025-09-12 18:26:08 +00:00

Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122 ).

build / test (pull_request) Failing after 7m31s

Details

build / docs (pull_request) Has been skipped

Details

947dc77a50

witten added 1 commit

2025-09-12 19:55:14 +00:00

Update automated tests (#1122 ).

build / test (pull_request) Failing after 6m27s

Details

build / docs (pull_request) Has been skipped

Details

f60007545b

witten changed title from ~~WIP: Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122).~~ to Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122).

2025-09-12 19:56:15 +00:00

witten changed title from ~~Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122).~~ to WIP: Always error and exit when the borgmatic runtime directory overlaps with the configured excludes (#1122).

2025-09-12 20:53:29 +00:00

witten added 1 commit

2025-09-12 21:04:20 +00:00

Bring doc string up to date and rename function for clarity. (#1122 ).

build / test (pull_request) Failing after 6m25s

Details

build / docs (pull_request) Has been skipped

Details

5028fe9ff4

witten added 1 commit

2025-09-13 05:18:36 +00:00

Account for the case where "store_config_files: false" and the runtime directory never gets added to patterns to begin with (#1122 ).