Polish changelogs (#5308)

* polish changelogs

* Additional changelog polishing

* fix test failure

* Correct changelog for recover command

---------

Co-authored-by: Leo R. Lundgren <leo@finalresort.org>
This commit is contained in:
Michael Eischer
2025-03-25 18:12:51 +01:00
committed by GitHub
parent 9eee32131a
commit 823cc3d93a
31 changed files with 107 additions and 130 deletions

View File

@@ -1,7 +1,7 @@
Enhancement: Add JSON support to check
Enhancement: Add JSON support to `check` command
Restic `check` now also supports the `--json` option and gives all
statistics in JSON format.
The `check` command now supports the `--json` option to output all statistics in
JSON format.
https://github.com/restic/restic/issues/1378
https://github.com/restic/restic/pull/5194

View File

@@ -1,9 +1,7 @@
Bugfix: Correctly restore timestamp on long filepaths on old Windows versions
Bugfix: Correctly restore long filepaths' timestamp on old Windows
The `restore` command did not restore timestamps on file paths longer than 256
characters on Windows versions before Windows 10 1607.
This issue is now resolved.
The `restore` command now correctly restores timestamps for files with paths longer
than 256 characters on Windows versions prior to Windows 10 1607.
https://github.com/restic/restic/issues/1843
https://github.com/restic/restic/pull/5061

View File

@@ -1,15 +1,12 @@
Bugfix: Ignore disappeared backup source files
If during a backup files were removed between restic listing the directory
content and backing up the file in question, the following error could occur:
The `backup` command now quietly skips files that are removed between directory
listing and backup, instead of printing errors like:
```
error: lstat /some/file/name: no such file or directory
```
The backup command now ignores this particular error and silently skips the
removed file.
https://github.com/restic/restic/issues/2165
https://github.com/restic/restic/issues/3098
https://github.com/restic/restic/pull/5143

View File

@@ -1,6 +1,7 @@
Enhancement: Allow generating shell completions to stdout
Enhancement: Support generating shell completions to stdout
Restic `generate` now supports passing `-` passed as file name to `--[shell]-completion` option.
The `generate` command now supports using `-` as the filename with the
`--[shell]-completion` option to write the generated output to stdout.
https://github.com/restic/restic/issues/2511
https://github.com/restic/restic/pull/5053

View File

@@ -1,9 +1,10 @@
Enhancement: Add warmup support on S3 backend before repacks and restores
Enhancement: Add experimental S3 cold storage support
Introduce S3 backend options for transitioning pack files from cold to hot
storage on S3 and S3-compatible providers. Note: only works before repacks
(prune/copy) and restore for now, and gated behind a new "s3-restore" feature
flag.
Introduce S3 backend options for transitioning pack files from cold to hot storage
on S3 and S3-compatible providers. Note: this only works for the `prune`, `copy`
and `restore` commands for now.
This experimental feature is gated behind the "s3-restore" feature flag.
https://github.com/restic/restic/pull/5173
https://github.com/restic/restic/issues/3202

View File

@@ -1,12 +1,12 @@
Enhancement: Allow excluding online-only cloud files (e.g. OneDrive)
Restic treated OneDrive Files On-Demand as though they were regular files
for the purpose of backup which caused issues with VSS, could make backup
incredibly slow (as OneDrive attempted to download files), or could fill
the source disk (e.g. 1TB of files in OneDrive on a 500GB disk).
Restic treated files synced using OneDrive Files On-Demand as though they
were regular files. This caused issues with VSS and could cause OneDrive to
download all files.
Restic now allows the user to exclude these files when backing up with
the `--exclude-cloud-files` switch.
the `--exclude-cloud-files` option.
https://github.com/restic/restic/issues/3697
https://github.com/restic/restic/issues/4935
https://github.com/restic/restic/pull/4990
https://github.com/restic/restic/pull/4990

View File

@@ -1,11 +1,8 @@
Enhancement: add sort options for `ls` command
Enhancement: Add `sort` option to `ls` command
in the past, the output of ls -l was sorted by name. Now it can be sorted by
one of the specifiers (name|size|time=mtime|atime|ctime|extension).
Use --sort <sortable field> to achieve this.
Reverse sorting also has been implemtented. Use --reverse to indicate reverse
sorting.
The `ls -l` command output can now be sorted using the new `--sort <field>`
option for the fields `name`, `size`, `time` (same as `mtime`), `mtime`,
`atime`, `ctime` and `extension`. A `--reverse` option is also available.
https://github.com/restic/restic/issues/4179
https://github.com/restic/restic/pull/5182

View File

@@ -1,9 +1,7 @@
Enhancement: Sort `find` output from newest to oldest and add `--reverse` option
Enhancement: Change default sort order for `find` output
The old output behaviour was to sort snapshots from oldest to newest.
The new sorting order is from newest to oldest. If one wants to revert to the
old behaviour, use the option --reverse.
The `find` command now sorts snapshots from newest to oldest by default. The
previous oldest-to-newest order can be restored using the new `--reverse` option.
https://github.com/restic/restic/issues/4433
https://github.com/restic/restic/pull/5184

View File

@@ -1,21 +1,12 @@
Enhancement: Add config option to set Microsoft Blob Storage Access Tier
Enhancement: Add support for Microsoft Blob Storage access tiers
The `azure.access-tier` option can be passed to Restic (using `-o`) to
specify the access tier for Microsoft Blob Storage objects created by Restic.
The access tier is passed as-is to Microsoft Blob Storage, so it needs to be
understood by the API. The allowed values are `Hot`, `Cool`, or `Cold`.
If unspecified, the default is inferred from the default configured on the
storage account.
You can mix access tiers in the same container, and the setting isn't
stored in the restic repository, so be sure to specify it with each
command that writes to Microsoft Blob Storage.
The new `-o azure.access-tier=<tier>` option allows specifying the access tier
(`Hot`, `Cool` or `Cold`) for objects created in Microsoft Blob Storage. If
unspecified, the storage account's default tier is used.
There is no official `Archive` storage support in restic, use this option at
your own risk. To restore any data, it is still necessary to manually warm up
the required data in the `Archive` tier.
your own risk. To restore any data, it is necessary to manually warm up the
required data in the `Archive` tier.
https://github.com/restic/restic/issues/4521
https://github.com/restic/restic/pull/5046
https://github.com/restic/restic/pull/5046

View File

@@ -1,11 +1,11 @@
Enhancement: support creating snapshot summary statistics for old snapshots
Enhancement: Add snapshot summary statistics to rewritten snapshots
When `rewrite` is used with the `--snapshot-summary` option, a new snapshot is
created containing statistics summary data. Only two fields in the summary will
be non-zero: `TotalFilesProcessed` and `TotalBytesProcessed`.
The `rewrite` command now supports a `--snapshot-summary` option to add
statistics data to snapshots. Only two fields in the summary will be non-zero:
`TotalFilesProcessed` and `TotalBytesProcessed`.
When rewrite is called with one of the `--exclude` options, `TotalFilesProcessed`
and `TotalBytesProcessed` will be updated in the snapshot summary.
For snapshots rewritten using the `--exclude` options, the summary
statistics are updated accordingly.
https://github.com/restic/restic/issues/4942
https://github.com/restic/restic/pull/5185

View File

@@ -1,6 +1,6 @@
Enhancement: Format exit errors as JSON with --json
Enhancement: Format exit errors as JSON when requested
Restic now prints any exit error messages as JSON when requested.
Restic now formats error messages as JSON when the `--json` flag is used.
https://github.com/restic/restic/issues/4948
https://github.com/restic/restic/pull/4952

View File

@@ -1,8 +1,10 @@
Enhancement: add SLSA provenance to the GHCR Container images
Enhancement: Add SLSA provenance to GHCR container images
Restic's GitHub Container Registry (GHCR) image build workflow now includes
SLSA provenance generation. This enhancement improves the security and
traceability of images built and pushed to GHCR.
SLSA (Supply-chain Levels for Software Artifacts) provenance generation.
Please see the restic documentation for more information about verifying SLSA
provenance.
https://github.com/restic/restic/issues/4983
https://github.com/restic/restic/pull/4999
https://github.com/restic/restic/pull/4999

View File

@@ -1,7 +1,7 @@
Enhancement: Retry loading repository config
Enhancement: Add retry mechanism for loading repository config
Restic now retries loading the repository config file when opening a repository.
In addition, the `init` command now also retries backend operations.
The `init` command now also retries backend operations.
https://github.com/restic/restic/issues/5081
https://github.com/restic/restic/pull/5095

View File

@@ -1,13 +1,8 @@
Enhancement: Allow including/excluding extended file attributes during restore
Enhancement: Allow including/excluding extended file attributes during `restore`
Restic restore attempts to restore all extended file attributes.
Now two new command line flags are added to restore to control which
extended file attributes will be restored.
The new flags are `--exclude-xattr` and `--include-xattr`.
If the flags are not provided, restic will default to restoring
all extended file attributes.
The `restore` command now supports the `--exclude-xattr` and `--include-xattr`
options to control which extended file attributes will be restored. By default,
all attributes are restored.
https://github.com/restic/restic/issues/5089
https://github.com/restic/restic/pull/5129

View File

@@ -1,8 +1,7 @@
Enhancement: Indicate the of deleted files/directories during restore
Enhancement: Show count of deleted files and directories during `restore`
Restic now indicates the number of deleted files/directories during restore.
The `--json` output now includes a `files_deleted` field that shows the number
of files and directories that were deleted during restore.
The `restore` command now reports the number of deleted files and directories,
both in the regular output and in the `files_deleted` field of the JSON output.
https://github.com/restic/restic/issues/5092
https://github.com/restic/restic/pull/5100

View File

@@ -1,7 +1,7 @@
Enhancement: Make small pack size configureable for `prune`
Enhancement: Make small pack size configurable for `prune`
The `prune` command now supports the `--repack-smaller-than` option that
allows repacking pack files smaller than the given size.
allows repacking pack files smaller than a specified size.
https://github.com/restic/restic/issues/5109
https://github.com/restic/restic/pull/5183

View File

@@ -1,4 +1,4 @@
Enhancement: Add DragonflyBSD support
Enhancement: Add DragonFlyBSD support
Restic can now be compiled on DragonflyBSD.

View File

@@ -1,8 +1,8 @@
Enhancement: Restic tag command returns the modified snapshot information
Enhancement: Make `tag` command print which snapshots were modified
Restic `tag` command now returns the modified snapshot information in the
output. Added `--json` option to the command to get the output in JSON format
for scripting access.
The `tag` command now outputs which snapshots were modified along with their
new snapshot ID. The command supports the `--json` option for machine-readable
output.
https://github.com/restic/restic/issues/5137
https://github.com/restic/restic/pull/5144
https://github.com/restic/restic/pull/5144

View File

@@ -1,6 +1,7 @@
Enhancement: Enable xattr support, on NetBSD 10+
Enhancement: Add xattr support for NetBSD 10+
Restic now supports backing up, and restoring extended attributes, on systems running NetBSD 10, or later.
Extended attribute support for `backup` and `restore` operations
is now available on NetBSD version 10 and later.
https://github.com/restic/restic/issues/5174
https://github.com/restic/restic/pull/5180

View File

@@ -1,7 +1,7 @@
Bugfix: Fix rare crash in command output
Some commands could in rare cases crash when trying to print status messages
and request retries at the same time. This resulted in an error like the following:
and request retries at the same time, resulting in an error like the following:
```
panic: runtime error: slice bounds out of range [468:156]
@@ -10,7 +10,7 @@ github.com/restic/restic/internal/ui/termstatus.(*lineWriter).Write(...)
/restic/internal/ui/termstatus/stdio_wrapper.go:36 +0x136
```
This has been fixed.
This has now been fixed.
https://github.com/restic/restic/issues/5259
https://github.com/restic/restic/pull/5300

View File

@@ -1,8 +1,8 @@
Enhancement: `recover` automatically runs `repair index`
Enhancement: Make `recover` automatically rebuild index when needed
When trying to recover data from an interrupted snapshot, it was necessary
to manually run `restic repair index` before runnning `restic recover`.
This now happens automatically.
When trying to recover data from an interrupted snapshot, it was previously
necessary to manually run `repair index` before runnning `recover`. This now
happens automatically so that only `recover` is necessary.
https://github.com/restic/restic/issues/52897
https://github.com/restic/restic/pull/5296

View File

@@ -1,8 +1,6 @@
Change: Update dependencies and require Go 1.23 or newer
We have updated all dependencies. Since some libraries require newer Go
standard library features, support for Go 1.19, 1.20, 1.21 and 1.22 has been
dropped, which means that restic now requires at least Go 1.23 to build.
We have updated all dependencies. Restic now requires Go 1.23 or newer to build.
This also disables support for TLS versions older than TLS 1.2. On Windows,
restic now requires at least Windows 10 or Windows Server 2016. On macOS,

View File

@@ -1,7 +1,6 @@
Enhancement: Compress ZIP archives created by `dump` command
Enhancement: Enable compression for ZIP archives in `dump` command
Restic did not compress the archives that were created by using
the `dump` command. It now saves some disk space when exporting
archives using the DEFLATE algorithm for "zip" archives.
The `dump` command now compresses ZIP archives using the DEFLATE algorithm,
reducing the size of exported archives.
https://github.com/restic/restic/pull/5054

View File

@@ -1,6 +1,6 @@
Enhancement: Include backup start and end in JSON output
Enhancement: Add start and end timestamps to `backup` JSON output
The JSON output of the backup command now also includes the timestamps
of the `backup_start` and `backup_end` times.
The JSON output of the `backup` command now includes `backup_start` and
`backup_end` timestamps, containing the start and end time of the backup.
https://github.com/restic/restic/pull/5119

View File

@@ -1,7 +1,7 @@
Enhancement: Provide clear error message if AZURE_ACCOUNT_NAME is not set
If AZURE_ACCOUNT_NAME is not set, any command related to an Azure repository
would result in a misleading networking error. Restic will now detect this and
provide a clear warning that the variable is not defined.
If `AZURE_ACCOUNT_NAME` was not set, commands related to an Azure repository
would result in a misleading networking error. Restic now detect this and
provides a clear warning that the variable is not defined.
https://github.com/restic/restic/pull/5141

View File

@@ -1,6 +1,7 @@
Bugfix: Include root tree when searching using `find --tree`
`restic find --tree` didn't find trees referenced by `restic snapshot --json`.
It now correctly includes the root tree when searching.
The `restic find --tree` command did not find trees referenced by
`restic snapshot --json`. It now correctly includes the root tree
when searching.
https://github.com/restic/restic/pull/5153

View File

@@ -1,7 +1,7 @@
Change: Promote feature flags
The `explicit-s3-anonymous-auth` and `safe-forget-keep-tags` features are
now stable and can no longer be disabled. The feature flags will be removed
in restic 0.19.0.
now stable and can no longer be disabled. These corresponding feature flags
will be removed in restic 0.19.0.
https://github.com/restic/restic/pull/5162

View File

@@ -1,6 +1,7 @@
Bugfix: Prevent Windows VSS event log 8194 warnings for backup with fs snapshot
When running `restic backup` with `--use-fs-snapshot` flag in Windows with admin rights, event logs like
When running `backup` with the `--use-fs-snapshot` option in Windows with admin rights, event logs like
```
Volume Shadow Copy Service error: Unexpected error querying for the IVssWriterCallback interface. hr = 0x80070005, Access is denied.
. This is often caused by incorrect security settings in either the writer or requester process.
@@ -13,8 +14,8 @@ Context:
Writer Name: System Writer
Writer Instance ID: {54b151ac-d27d-4628-9cb0-2bc40959f50f}
```
are created several times(the backup itself succeeds). Prevent this from occurring.
are created several times even though the backup itself succeeds. This has now been fixed.
https://github.com/restic/restic/issues/5169
https://github.com/restic/restic/pull/5170

View File

@@ -1,10 +1,8 @@
Bugfix: Correctly account for duplicate data in `prune --max-unused`
Bugfix: Fix duplicate data handling in `prune --max-unused`
`prune --max-unused size` did not correctly account for duplicate data.
If a repository contained a large amount of duplicate data, this could
previously result in pruning too little data.
This issue is now resolved.
The `prune --max-unused size` command did not correctly account for duplicate
data. If a repository contained a large amount of duplicate data, this could
previously result in pruning too little data. This has now been fixed.
https://github.com/restic/restic/pull/5212
https://forum.restic.net/t/restic-not-obeying-max-unused-parameter-on-prune/8879

View File

@@ -1,10 +1,10 @@
Bugfix: Fix creation of oversized indexes by `repair index --read-all-packs`
Bugfix: Fix creation of oversized index by `repair index --read-all-packs`
Since restic 0.17.0, the new index created by `repair index --read-all-packs` was
written as a single large index. This significantly increases memory usage while
written as a single large index. This significantly increased memory usage while
loading the index.
The index is now correctly split into multiple smaller indexes. `repair index` now
also automatically splits oversized indexes.
The index is now correctly split into multiple smaller indexes, and `repair index`
now also automatically splits oversized indexes.
https://github.com/restic/restic/pull/5249

View File

@@ -1,8 +1,8 @@
Enhancement: Improve handling of flaky rclone backends
Enhancement: Improve retry handling for flaky `rclone` backends
Since restic 0.17.0, the backend retry mechanisms relies on backends correctly
reporting when a file does not exist. This is not always the case for some rclone
backends, causing restic to stop retrying after the first failure.
Since restic 0.17.0, the backend retry mechanisms rely on backends correctly
reporting when a file does not exist. This is not always the case for some
`rclone` backends, which caused restic to stop retrying after the first failure.
For rclone, failed requests are now retried up to 5 times before giving up.