peter/borgmatic
1
0
Fork 0
mirror of https://github.com/borgmatic-collective/borgmatic.git synced 2026-08-06 16:23:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Context tweaks + mention configuration upgrade in command hook documentation (#1019).

Browse Source
This commit is contained in:
Dan Helfman
2025-03-11 14:07:06 -07:00
parent b4d24798bf
commit 325f53c286
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to/add-preparation-and-cleanup-steps-to-backups.md
+9 -4
View File
@@ -38,8 +38,13 @@ commands:
- echo "Something went wrong!"
```
If a `run:` command contains a special YAML character such as a colon, you may
need to quote the entire string (or use a [multiline
If you're coming from an older version of borgmatic, there is tooling to help
you [upgrade your
configuration](https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-your-configuration)
to this new command hook format.
Note that if a `run:` command contains a special YAML character such as a colon,
you may need to quote the entire string (or use a [multiline
string](https://yaml-multiline.info/)) to avoid an error:
```yaml
@@ -61,8 +66,8 @@ Each command in the `commands:` list has the following options:
* `when`: Only trigger the hook when borgmatic is run with particular actions (`create`, `prune`, etc.) listed here. Defaults to running for all actions.
* `run`: List of one or more shell commands or scripts to run when this command hook is triggered.
Note that borgmatic does not run `error` hooks if an error occurs within an
`everything` hook.
borgmatic does not run `error` hooks if an error occurs within an `everything`
hook.
There's also another command hook that works a little differently: