Use (current) default action order whenever actions are mentioned (#873).
All checks were successful
build / test (push) Successful in 6m9s
build / docs (push) Successful in 1m30s

This commit is contained in:
Dan Helfman 2024-06-05 11:21:51 -07:00
parent 70a978b83d
commit b5ab1ff0cd
2 changed files with 7 additions and 7 deletions

View File

@ -20,7 +20,7 @@ default action ordering was `prune`, `compact`, `create`, and `check`.
### A la carte actions ### A la carte actions
If you find yourself wanting to customize the actions, you have some options. If you find yourself wanting to customize the actions, you have some options.
First, you can run borgmatic's `prune`, `compact`, `create`, or `check` First, you can run borgmatic's `create`, `prune`, `compact`, or `check`
actions separately. For instance, the following optional actions are actions separately. For instance, the following optional actions are
available (among others): available (among others):

View File

@ -208,8 +208,8 @@ cronitor:
this option in the `hooks:` section of your configuration. this option in the `hooks:` section of your configuration.
With this configuration, borgmatic pings your Cronitor monitor when a backup With this configuration, borgmatic pings your Cronitor monitor when a backup
begins, ends, or errors, but only when any of the `prune`, `compact`, begins, ends, or errors, but only when any of the `create`, `prune`,
`create`, or `check` actions are run. Then, if the actions complete `compact`, or `check` actions are run. Then, if the actions complete
successfully or errors, borgmatic notifies Cronitor accordingly. successfully or errors, borgmatic notifies Cronitor accordingly.
You can configure Cronitor to notify you by a [variety of You can configure Cronitor to notify you by a [variety of
@ -235,8 +235,8 @@ cronhub:
this option in the `hooks:` section of your configuration. this option in the `hooks:` section of your configuration.
With this configuration, borgmatic pings your Cronhub monitor when a backup With this configuration, borgmatic pings your Cronhub monitor when a backup
begins, ends, or errors, but only when any of the `prune`, `compact`, begins, ends, or errors, but only when any of the `create`, `prune`,
`create`, or `check` actions are run. Then, if the actions complete `compact`, or `check` actions are run. Then, if the actions complete
successfully or errors, borgmatic notifies Cronhub accordingly. successfully or errors, borgmatic notifies Cronhub accordingly.
Note that even though you configure borgmatic with the "start" variant of the Note that even though you configure borgmatic with the "start" variant of the
@ -368,7 +368,7 @@ loki:
``` ```
With this configuration, borgmatic sends its logs to your Loki instance as any With this configuration, borgmatic sends its logs to your Loki instance as any
of the `prune`, `compact`, `create`, or `check` actions are run. Then, after of the `create`, `prune`, `compact`, or `check` actions are run. Then, after
the actions complete, borgmatic notifies Loki of success or failure. the actions complete, borgmatic notifies Loki of success or failure.
This hook supports sending arbitrary labels to Loki. For instance: This hook supports sending arbitrary labels to Loki. For instance:
@ -444,7 +444,7 @@ apprise:
With this configuration, borgmatic pings each of the configured Apprise With this configuration, borgmatic pings each of the configured Apprise
services when a backup begins, ends, or errors, but only when any of the services when a backup begins, ends, or errors, but only when any of the
`prune`, `compact`, `create`, or `check` actions are run. (By default, if `create`, `prune`, `compact`, or `check` actions are run. (By default, if
`states` is not specified, Apprise services are only pinged on error.) `states` is not specified, Apprise services are only pinged on error.)
You can optionally customize the contents of the default messages sent to You can optionally customize the contents of the default messages sent to