Skip to content

on_failure -> on-failure #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aawsome merged 1 commit into from
May 14, 2026
Merged

on_failure -> on-failure #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/commands/misc/hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,17 +109,17 @@ Note that `global` variables are provided to all commands.

By default, if a hook command fails, `rustic` will log the error and stop. If
you would like `rustic` to continue its process with just a warning in the logs
or nothing, you can use the `on_failure` field.
or nothing, you can use the `on-failure` field.

The `on_failure` field takes `"error"` by default and can take `"warn"` and
The `on-failure` field takes `"error"` by default and can take `"warn"` and
`"ignore"` as well.

A first way to write it:

```toml
[backup.hooks]
run-after = [
{ command = "notify-send", args = ["Backup finished successfully!"], on_failure = "warn" },
{ command = "notify-send", args = ["Backup finished successfully!"], on-failure = "warn" },
]
```

Expand All @@ -130,7 +130,7 @@ An alternative way possible with the toml format:
command = "notify-send"
args = ["Backup finished successfully!"]
# optional
on_failure = "warn" # possible values are "error" (default), "warn", "ignore"
on-failure = "warn" # possible values are "error" (default), "warn", "ignore"
```

## Use cases
Expand Down
Loading