Hi Martin

Thanks for your feedback :)

On Sat, 08 Mar 2025 12:31:17 +0100 Martin Dosch <[email protected]> wrote:
>
> during upgrading I got the following message:
> 
>     Pay attention to changes in borgmatic when upgrading!
> 
>     Look for breaking changes since bookworm version 1.7.7 in
>     /usr/share/doc/borgmatic/changelog.gz
> 
> IMO you should list breaking changes directly instead of asking people
> to look in the changelog to check if there are breaking changes.

Because there was so many changes, I though it was better to point to
the exhaustive changelog and let users identify what is relevant for
their setup.

Anyway here is a extract I made, what do you think?

-------------------------------8<-------------------------------

1.9.3
 * deprecate the "store_config_files" option at the global scope and move it 
under the "bootstrap"
   hook. see the documentation for more information:
   
https://torsion.org/borgmatic/docs/how-to/extract-a-backup/#extract-the-configuration-files-used-to-create-an-archive

1.9.2
 * #722: remove the restriction that the "extract" and "mount" actions must 
match a single
   repository. now they work more like other actions, where each repository is 
applied in turn.

1.9.0
 * #609: breaking: apply the "working_directory" option to all actions, not 
just "create". this
   includes repository paths, destination paths, mount points, etc.
 * #562: deprecate the "borgmatic_source_directory" option in favor of 
"user_runtime_directory"
   and "user_state_directory".
 * #562: breaking: move the default borgmatic streaming database dump and 
bootstrap metadata
   directory from ~/.borgmatic to /run/user/$uid/borgmatic, which is more 
xdg-compliant. you can
   override this location with the new "user_runtime_directory" option. 
existing archives with
   database dumps at the old location are still restorable.
 * #562, #638: move the default check state directory from ~/.borgmatic to
   ~/.local/state/borgmatic. this is more xdg-compliant and also prevents these 
state files from
   getting backed up (unless you explicitly include them). you can override 
this location with the
   new "user_state_directory" option. after the first time you run the "check" 
action with borgmatic
   1.9.0, you can safely delete the ~/.borgmatic directory.
 * #838: breaking: with borg 1.4+, store database dumps and bootstrap metadata 
in a "/borgmatic"
   directory within a backup archive, so the path doesn't depend on the current 
user. this means
   that you can now backup as one user and restore or bootstrap as another 
user, among other use
   cases.
 * #915: breaking: rename repository actions like "rcreate" to more explicit 
names like
   "repo-create" for compatibility with recent changes in borg 2.0.0b10.
 * #918: breaking: when databases are configured, don't auto-enable the 
"one_file_system" option,
   as existing auto-excludes of special files should be sufficient to prevent 
borg from hanging on
   them. but if this change causes problems for you, you can always enable 
"one_file_system"
   explicitly.
 * #921: breaking: change soft failure command hooks to skip only the current 
repository rather than
   all repositories in the configuration file.
 * when using borg 2, default the "archive_name_format" option to just 
"{hostname}", as borg 2 does
   not require unique archive names; identical archive names form a common 
"series" that can be
   targeted together. see the borg 2 documentation for more information:
   
https://borgbackup.readthedocs.io/en/2.0.0b13/changes.html#borg-1-2-x-1-4-x-to-borg-2-0

1.8.5
 * #701: deprecate the "disabled" value for the "checks" option in favor of the 
new "skip_actions"
   option.

1.8.3
 * #665: breaking: simplify logging logic as follows: syslog verbosity is now 
disabled by
   default, but setting the "--syslog-verbosity" flag enables it regardless of 
whether you're at an
   interactive console. additionally, "--log-file-verbosity" and 
"--monitoring-verbosity" now
   default to 1 (info about steps borgmatic is taking) instead of 0. and both 
syslog logging and
   file logging can be enabled simultaneously.

1.8.0
 * #575: breaking: for the "borgmatic borg" action, instead of implicitly 
injecting
   repository/archive into the resulting borg command-line, pass repository to 
borg via an
   environment variable and make archive available for explicit use in your 
commands. see the
   documentation for more information:
   https://torsion.org/borgmatic/docs/how-to/run-arbitrary-borg-commands/
 * #721: remove configuration sections ("location:", "storage:", "hooks:", 
etc.), while still
   keeping deprecated support for them. now, all options are at the same level, 
and you don't need
   to worry about commenting/uncommenting section headers when you change an 
option (if you remove
   your sections first).
 * #721: breaking: the retention prefix and the consistency prefix can no 
longer have different
   values (unless one is not set).
 * #721: breaking: the storage umask and the hooks umask can no longer have 
different values (unless
   one is not set).
 * breaking: flags like "--config" that previously took multiple values now 
need to be given once
   per value, e.g. "--config first.yaml --config second.yaml" instead of 
"--config first.yaml
   second.yaml". this prevents argument parsing errors on ambiguous commands.
 * breaking: remove the deprecated (and silently ignored) "--successful" flag 
on the "list" action,
   as newer versions of borg list successful (non-checkpoint) archives by 
default.
 * all deprecated configuration option values now generate warning logs.
 * remove the deprecated (and non-functional) "--excludes" flag in favor of 
excludes within
   configuration.

1.7.15
 * #529: deprecate generate-borgmatic-config in favor of new "config generate" 
action.
 * #529: deprecate validate-borgmatic-config in favor of new "config validate" 
action.
 * #697, #712, #716: extract borgmatic configuration from backup via new 
"config bootstrap"
   action—even when borgmatic has no configuration yet!

1.7.11
 * #479, #588: breaking: automatically use the "archive_name_format" option to 
filter which archives
   get used for borgmatic actions that operate on multiple archives. override 
this behavior with the
   new "match_archives" option in the storage section. this change is 
"breaking" in that it silently
   changes which archives get considered for "rlist", "prune", "check", etc. 
see the documentation
   for more information:
   
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#archive-naming
 * #479, #588: the "prefix" options have been deprecated in favor of the new 
"archive_name_format"
   auto-matching behavior and the "match_archives" option.

1.7.9
 * #304: change the default action order when no actions are specified on the 
command-line to:
   "create", "prune", "compact", "check". if you'd like to retain the old 
ordering ("prune" and
   "compact" first), then specify actions explicitly on the command-line.
 * #304: run any command-line actions in the order specified instead of using a 
fixed ordering.

------------------------------->8-------------------------------

Should I change the current debian/NEWS file or do I append a new entry?

Cheers
k

Reply via email to