Skip to content

Commit

Permalink
docs: add breaking changes documentation
Browse files Browse the repository at this point in the history
Signed-off-by: simonsan <[email protected]>
  • Loading branch information
simonsan committed Sep 18, 2024
1 parent 6883de0 commit 01bb591
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Contributing to rustic](./contributing-to-rustic.md)
- [FAQ](./FAQ.md)
- [Comparison `rustic` and `restic`](./comparison-restic.md)
- [Breaking Changes](./breaking_changes.md)
- [Installation](./installation.md)
- [Nightly Builds](./nightly_builds.md)
- [Completions](./commands/misc/completions.md)
Expand Down
22 changes: 22 additions & 0 deletions src/breaking_changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Breaking Changes

This document lists all user facing breaking changes in `rustic` and provides
guidance on how to migrate from one version to another.

## 0.9.0

### Configuration File

Consistently apply singular and plural naming conventions for keys in the
configuration file that accept an array of values. This change affects the
following keys:

- glob -> globs
- iglob -> iglobs
- glob_file -> glob_files
- iglob_file -> iglob_files
- custom_ignorefile -> custom_ignorefiles
- tag -> tags

You need to update your configuration file accordingly, changing the key names
from singular to plural.

0 comments on commit 01bb591

Please sign in to comment.