docs: expand restic find - documentation (#5675)

* mount: check for more requisite mountpoint conditions

In order to be able to mount a repository over a mountpoint target
directory via FUSE, that target directory needs to be both writeable and
executable for the UID performing the mount.

Without this patch, `restic mount` only checks for the target pathname's
existence, which can lead to a lot of data transfer and/or computation
for large repos to be performed before eventually croaking with a fatal
"fusermount: failed to chdir to mountpoint: Permission denied" (or
similar) error.

FUSE does allow for mounting over a target path that refers to a regular
(writeable) file, but the result is not accessible via chdir(), so we
prevent that as well, and accept only directory inodes as the intended
target mountpoint path.

* Don't use snake_case identifiers

* Add changelog entry

* tweak changelog summary

---------

Co-authored-by: Michael Eischer <michael.eischer@fau.de>

.dockerignore

@@ -0,0 +1,12 @@
+# Actual layer caching is impossible due to .git, but
+# that must be included for provenance reasons.  These ignores
+# are strictly for hygenic build.
+*
+!/*.go
+!/go.*
+!/cmd/*
+!/docker/entrypoint.sh
+!/internal/*
+!/helpers/*
+!/VERSION
+!/.git/

.github/PULL_REQUEST_TEMPLATE.md

@@ -28,13 +28,15 @@ Checklist
 You do not need to check all the boxes below all at once. Feel free to take
 your time and add more commits. If you're done and ready for review, please
 check the last box. Enable a checkbox by replacing [ ] with [x].
+
+Please always follow these steps:
+- Read the [contribution guidelines](https://github.com/restic/restic/blob/master/CONTRIBUTING.md#providing-patches).
+- Enable [maintainer edits](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
+- Run `gofmt` on the code in all commits.
+- Format all commit messages in the same style as [the other commits in the repository](https://github.com/restic/restic/blob/master/CONTRIBUTING.md#git-commits).
 -->
 
-- [ ] I have read the [contribution guidelines](https://github.com/restic/restic/blob/master/CONTRIBUTING.md#providing-patches).
-- [ ] I have [enabled maintainer edits](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
-- [ ] I have added tests for all code changes.
+- [ ] I have added tests for all code changes, see [writing tests](https://restic.readthedocs.io/en/stable/090_participating.html#writing-tests)
 - [ ] I have added documentation for relevant changes (in the manual).
 - [ ] There's a new file in `changelog/unreleased/` that describes the changes for our users (see [template](https://github.com/restic/restic/blob/master/changelog/TEMPLATE)).
-- [ ] I have run `gofmt` on the code in all commits.
-- [ ] All commit messages are formatted in the same style as [the other commits in the repo](https://github.com/restic/restic/blob/master/CONTRIBUTING.md#git-commits).
 - [ ] I'm done! This pull request is ready for review.

.github/dependabot.yml

@@ -5,6 +5,10 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "monthly"
+    groups:
+      golang-x-deps:
+        patterns:
+          - "golang.org/x/*"
 
   # Dependencies listed in .github/workflows/*.yml
   - package-ecosystem: "github-actions"

.github/workflows/docker.yml

@@ -20,12 +20,16 @@ jobs:
       contents: read
       packages: write
 
+    outputs:
+      image: ${{ steps.image.outputs.image }}
+      digest: ${{ steps.build-and-push.outputs.digest }}
+
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Log in to the Container registry
-        uses: docker/login-action@3d58c274f17dffee475a5520cbe67f0a882c4dbb
+        uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -33,10 +37,11 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
+            type=sha
             type=ref,event=branch
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
@@ -45,7 +50,7 @@ jobs:
         uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226
+        uses: docker/setup-buildx-action@2b51285047da1547ffb1b2203d8be4c0af6b1f20
 
       - name: Ensure consistent binaries
         run: |
@@ -55,7 +60,8 @@ jobs:
         if: github.ref != 'refs/heads/master'
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        id: build-and-push
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1
         with:
           push: true
           context: .
@@ -64,3 +70,26 @@ jobs:
           pull: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+        
+      - name: Output image
+        id: image
+        run: |
+          # NOTE: Set the image as an output because the `env` context is not
+          # available to the inputs of a reusable workflow call.
+          image_name="${REGISTRY}/${IMAGE_NAME}"
+          echo "image=$image_name" >> "$GITHUB_OUTPUT"
+        
+  provenance:
+    needs: [build-and-push-image]
+    permissions:
+      actions: read # for detecting the Github Actions environment.
+      id-token: write # for creating OIDC tokens for signing.
+      packages: write # for uploading attestations.
+    if: github.repository == 'restic/restic'
+    uses: slsa-framework/slsa-github-generator/.github/workflows/generator_container_slsa3.yml@v2.1.0
+    with:
+      image: ${{ needs.build-and-push-image.outputs.image }}
+      digest: ${{ needs.build-and-push-image.outputs.digest }}
+      registry-username: ${{ github.actor }}
+    secrets:
+      registry-password: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ permissions:
   contents: read
 
 env:
-  latest_go: "1.22.x"
+  latest_go: "1.25.x"
   GO111MODULE: on
 
 jobs:
@@ -23,39 +23,29 @@ jobs:
         # list of jobs to run:
         include:
           - job_name: Windows
-            go: 1.22.x
+            go: 1.25.x
             os: windows-latest
 
           - job_name: macOS
-            go: 1.22.x
+            go: 1.25.x
             os: macOS-latest
             test_fuse: false
 
           - job_name: Linux
-            go: 1.22.x
+            go: 1.25.x
             os: ubuntu-latest
             test_cloud_backends: true
             test_fuse: true
             check_changelog: true
 
           - job_name: Linux (race)
-            go: 1.22.x
+            go: 1.25.x
             os: ubuntu-latest
             test_fuse: true
             test_opts: "-race"
 
           - job_name: Linux
-            go: 1.21.x
-            os: ubuntu-latest
-            test_fuse: true
-
-          - job_name: Linux
-            go: 1.20.x
-            os: ubuntu-latest
-            test_fuse: true
-
-          - job_name: Linux
-            go: 1.19.x
+            go: 1.24.x
             os: ubuntu-latest
             test_fuse: true
 
@@ -66,15 +56,18 @@ jobs:
       GOPROXY: https://proxy.golang.org
 
     steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
       - name: Set up Go ${{ matrix.go }}
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ matrix.go }}
 
       - name: Get programs (Linux/macOS)
         run: |
           echo "build Go tools"
-          go install github.com/restic/rest-server/cmd/rest-server@latest
+          go install github.com/restic/rest-server/cmd/rest-server@master
 
           echo "install minio server"
           mkdir $HOME/bin
@@ -106,7 +99,7 @@ jobs:
           $ProgressPreference = 'SilentlyContinue'
 
           echo "build Go tools"
-          go install github.com/restic/rest-server/...
+          go install github.com/restic/rest-server/cmd/rest-server@master
 
           echo "install minio server"
           mkdir $Env:USERPROFILE/bin
@@ -139,9 +132,6 @@ jobs:
           echo $Env:USERPROFILE\tar\bin >> $Env:GITHUB_PATH
         if: matrix.os == 'windows-latest'
 
-      - name: Check out code
-        uses: actions/checkout@v4
-
       - name: Build with build.go
         run: |
           go run build.go
@@ -195,7 +185,7 @@ jobs:
           # prepare credentials for Google Cloud Storage tests in a temp file
           export GOOGLE_APPLICATION_CREDENTIALS=$(mktemp --tmpdir restic-gcs-auth-XXXXXXX)
           echo $RESTIC_TEST_GS_APPLICATION_CREDENTIALS_B64 | base64 -d > $GOOGLE_APPLICATION_CREDENTIALS
-          go test -cover -parallel 4 ./internal/backend/...
+          go test -cover -parallel 5 -timeout 15m ./internal/backend/...
 
         # only run cloud backend tests for pull requests from and pushes to our
         # own repo, otherwise the secrets are not available
@@ -214,7 +204,6 @@ jobs:
 
   cross_compile:
     strategy:
-
       matrix:
         # run cross-compile in three batches parallel so the overall tests run faster
         subset:
@@ -230,14 +219,14 @@ jobs:
     name: Cross Compile for subset ${{ matrix.subset }}
 
     steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
       - name: Set up Go ${{ env.latest_go }}
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ env.latest_go }}
 
-      - name: Check out code
-        uses: actions/checkout@v4
-
       - name: Cross-compile for subset ${{ matrix.subset }}
         run: |
           mkdir build-output build-output-debug
@@ -247,20 +236,24 @@ jobs:
   lint:
     name: lint
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      # allow annotating code in the PR
+      checks: write
     steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
       - name: Set up Go ${{ env.latest_go }}
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ env.latest_go }}
 
-      - name: Check out code
-        uses: actions/checkout@v4
-
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v9
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.56.1
+          version: v2.4.0
           args: --verbose --timeout 5m
 
         # only run golangci-lint for pull requests, otherwise ALL hints get
@@ -294,11 +287,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           # list of Docker images to use as base name for tags
           images: |
@@ -321,7 +314,7 @@ jobs:
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           push: false
           context: .

.golangci.yml

@@ -1,61 +1,95 @@
-# This is the configuration for golangci-lint for the restic project.
-#
-# A sample config with all settings is here:
-# https://github.com/golangci/golangci-lint/blob/master/.golangci.example.yml
-
+version: "2"
 linters:
   # only enable the linters listed below
-  disable-all: true
+  default: none
   enable:
+    - asciicheck
+    # ensure that http response bodies are closed
+    - bodyclose
+    # restrict imports from other restic packages for internal/backend (cache exempt)
+    - depguard
+    - copyloopvar
     # make sure all errors returned by functions are handled
     - errcheck
-
-    # show how code can be simplified
-    - gosimple
-
-    # make sure code is formatted
-    - gofmt
-
     # examine code and report suspicious constructs, such as Printf calls whose
     # arguments do not align with the format string
     - govet
-
-    # make sure names and comments are used according to the conventions
-    - revive
-
+    # consistent imports
+    - importas
     # detect when assignments to existing variables are not used
     - ineffassign
-
+    - nolintlint
+    # make sure names and comments are used according to the conventions
+    - revive
     # run static analysis and find errors
     - staticcheck
-
     # find unused variables, functions, structs, types, etc.
     - unused
-
-    # parse and typecheck code
-    - typecheck
-
-    # ensure that http response bodies are closed
-    - bodyclose
-
-issues:
-  # don't use the default exclude rules, this hides (among others) ignored
-  # errors from Close() calls
-  exclude-use-default: false
-
-  # list of things to not warn about
-  exclude:
-    # revive: do not warn about missing comments for exported stuff
-    - exported (function|method|var|type|const) .* should have comment or be unexported
-    # revive: ignore constants in all caps
-    - don't use ALL_CAPS in Go names; use CamelCase
-    # revive: lots of packages don't have such a comment
-    - "package-comments: should have a package comment"
-    # staticcheck: there's no easy way to replace these packages
-    - "SA1019: \"golang.org/x/crypto/poly1305\" is deprecated"
-    - "SA1019: \"golang.org/x/crypto/openpgp\" is deprecated"
-
-  exclude-rules:
-    # revive: ignore unused parameters in tests
-    - path: (_test\.go|testing\.go|backend/.*/tests\.go)
-      text: "unused-parameter:"
+  settings:
+    depguard:
+      rules:
+        # Prevent backend packages from importing the internal/restic package to keep the architectural layers intact.
+        backend-imports:
+          files:
+            - "**/internal/backend/**"
+            - "!**/internal/backend/cache/**"
+            - "!**/internal/backend/test/**"
+            - "!**/*_test.go"
+          deny:
+            - pkg: "github.com/restic/restic/internal/restic"
+              desc: "internal/restic should not be imported to keep the architectural layers intact"
+            - pkg: "github.com/restic/restic/internal/repository"
+              desc: "internal/repository should not be imported to keep the architectural layers intact"
+    importas:
+      alias:
+        - pkg: github.com/restic/restic/internal/test
+          alias: rtest
+    staticcheck:
+      checks:
+        # default
+        - "all"
+        - "-ST1000"
+        - "-ST1003"
+        - "-ST1016"
+        - "-ST1020"
+        - "-ST1021"
+        - "-ST1022"
+        # extra disables
+        - "-QF1008" # don't warn about specifing name of embedded field on access
+  exclusions:
+    rules:
+      # revive: ignore unused parameters in tests
+      - path: (_test\.go|testing\.go|backend/.*/tests\.go)
+        text: "unused-parameter:"
+      # revive: do not warn about missing comments for exported stuff
+      - path: (.+)\.go$
+        text: exported (function|method|var|type|const) .* should have comment or be unexported
+      # revive: ignore constants in all caps
+      - path: (.+)\.go$
+        text: don't use ALL_CAPS in Go names; use CamelCase
+      # revive: lots of packages don't have such a comment
+      - path: (.+)\.go$
+        text: "package-comments: should have a package comment"
+      # staticcheck: there's no easy way to replace these packages
+      - path: (.+)\.go$
+        text: 'SA1019: "golang.org/x/crypto/poly1305" is deprecated'
+      - path: (.+)\.go$
+        text: 'SA1019: "golang.org/x/crypto/openpgp" is deprecated'
+      - path: (.+)\.go$
+        text: "redefines-builtin-id:"
+      # revive: collection of helpers to implement a backend, more descriptive names would be too repetitive
+      - path: internal/backend/util/.*.go$
+        text: "var-naming: avoid meaningless package names"
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    # make sure code is formatted
+    - gofmt
+  exclusions:
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

CONTRIBUTING.md

@@ -202,6 +202,9 @@ we'll be glad to assist. Having a PR with failing integration tests is nothing
 to be ashamed of. In contrast, that happens regularly for all of us. That's
 what the tests are there for.
 
+More details of how to structure tests can be found here at
+[writing tests](https://restic.readthedocs.io/en/stable/090_participating.html#writing-tests).
+
 Git Commits
 -----------
 

README.md

@@ -10,8 +10,7 @@ For detailed usage and installation instructions check out the [documentation](h
 
 You can ask questions in our [Discourse forum](https://forum.restic.net).
 
-Quick start
------------
+## Quick start
 
 Once you've [installed](https://restic.readthedocs.io/en/latest/020_installation.html) restic, start
 off with creating a repository for your backups:
@@ -59,7 +58,7 @@ Therefore, restic supports the following backends for storing backups natively:
 Restic is a program that does backups right and was designed with the
 following principles in mind:
 
--  **Easy:** Doing backups should be a frictionless process, otherwise
+-  **Easy**: Doing backups should be a frictionless process, otherwise
    you might be tempted to skip it. Restic should be easy to configure
    and use, so that, in the event of a data loss, you can just restore
    it. Likewise, restoring data should not be complicated.
@@ -92,20 +91,17 @@ reproduce a byte identical version from the source code for that
 release. Instructions on how to do that are contained in the
 [builder repository](https://github.com/restic/builder).
 
-News
-----
+## News
 
-You can follow the restic project on Mastodon [@resticbackup](https://fosstodon.org/@restic) or by subscribing to
+You can follow the restic project on Mastodon [@resticbackup](https://fosstodon.org/@restic) or subscribe to
 the [project blog](https://restic.net/blog/).
 
-License
--------
+## License
 
 Restic is licensed under [BSD 2-Clause License](https://opensource.org/licenses/BSD-2-Clause). You can find the
-complete text in [``LICENSE``](LICENSE).
+complete text in [`LICENSE`](LICENSE).
 
-Sponsorship
------------
+## Sponsorship
 
 Backend integration tests for Google Cloud Storage and Microsoft Azure Blob
 Storage are sponsored by [AppsCode](https://appscode.com)!

VERSION

@@ -1 +1 @@
-0.16.4
+0.18.1-dev

build.go

@@ -36,7 +36,6 @@
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 //go:build ignore_build_go
-// +build ignore_build_go
 
 package main
 
@@ -53,12 +52,14 @@ import (
 
 // config contains the configuration for the program to build.
 var config = Config{
-	Name:             "restic",                                 // name of the program executable and directory
-	Namespace:        "github.com/restic/restic",               // subdir of GOPATH, e.g. "github.com/foo/bar"
-	Main:             "./cmd/restic",                           // package name for the main package
-	DefaultBuildTags: []string{"selfupdate"},                   // specify build tags which are always used
-	Tests:            []string{"./..."},                        // tests to run
-	MinVersion:       GoVersion{Major: 1, Minor: 18, Patch: 0}, // minimum Go version supported
+	Name:      "restic",                   // name of the program executable and directory
+	Namespace: "github.com/restic/restic", // subdir of GOPATH, e.g. "github.com/foo/bar"
+	Main:      "./cmd/restic",             // package name for the main package
+	// disable_grpc_modules is necessary to reduce the binary size since cloud.google.com/go/storage v1.44.0
+	// see https://github.com/googleapis/google-cloud-go/issues/11448
+	DefaultBuildTags: []string{"selfupdate", "disable_grpc_modules"}, // specify build tags which are always used
+	Tests:            []string{"./..."},                              // tests to run
+	MinVersion:       GoVersion{Major: 1, Minor: 24, Patch: 0},       // minimum Go version supported
 }
 
 // Config configures the build.
@@ -298,19 +299,21 @@ func (v GoVersion) AtLeast(other GoVersion) bool {
 		return true
 	}
 
+	if v.Major > other.Major {
+		return true
+	}
 	if v.Major < other.Major {
 		return false
 	}
 
+	if v.Minor > other.Minor {
+		return true
+	}
 	if v.Minor < other.Minor {
 		return false
 	}
 
-	if v.Patch < other.Patch {
-		return false
-	}
-
-	return true
+	return v.Patch >= other.Patch
 }
 
 func (v GoVersion) String() string {
@@ -380,12 +383,6 @@ func main() {
 		}
 	}
 
-	solarisMinVersion := GoVersion{Major: 1, Minor: 20, Patch: 0}
-	if env["GOARCH"] == "solaris" && !goVersion.AtLeast(solarisMinVersion) {
-		fmt.Fprintf(os.Stderr, "Detected version %s is too old, restic requires at least %s for Solaris\n", goVersion, solarisMinVersion)
-		os.Exit(1)
-	}
-
 	verbosePrintf("detected Go version %v\n", goVersion)
 
 	preserveSymbols := false

changelog/0.10.0_2020-09-19/pull-2195

@@ -10,7 +10,7 @@ https://github.com/restic/restic/issues/2244
 
 NOTE: This new implementation does not guarantee order in which blobs
 are written to the target files and, for example, the last blob of a
-file can be written to the file before any of the preceeding file blobs.
+file can be written to the file before any of the preceding file blobs.
 It is therefore possible to have gaps in the data written to the target
 files if restore fails or interrupted by the user.
 

changelog/0.12.0_2021-02-14/issue-3232

@@ -1,7 +1,7 @@
-Bugfix: Correct statistics for overlapping targets
+Bugfix: Correct statistics for overlapping backup sources
 
 A user reported that restic's statistics and progress information during backup
-was not correctly calculated when the backup targets (files/dirs to save)
+was not correctly calculated when the backup sources (files/dirs to save)
 overlap. For example, consider a directory `foo` which contains (among others)
 a file `foo/bar`. When `restic backup foo foo/bar` was run, restic counted the
 size of the file `foo/bar` twice, so the completeness percentage as well as the

changelog/0.16.0_2023-07-31/issue-3941

@@ -1,7 +1,7 @@
 Enhancement: Support `--group-by` for backup parent selection
 
 Previously, the `backup` command by default selected the parent snapshot based
-on the hostname and the backup targets. When the backup path list changed, the
+on the hostname and the backup paths. When the backup path list changed, the
 `backup` command was unable to determine a suitable parent snapshot and had to
 read all files again.
 

changelog/0.16.5_2024-07-01/issue-4873

@@ -0,0 +1,6 @@
+Enhancement: Update dependencies
+
+A few potentially vulnerable dependencies were updated.
+
+https://github.com/restic/restic/issues/4873
+https://github.com/restic/restic/pull/4878

changelog/0.16.5_2024-07-01/pull-4799

@@ -0,0 +1,5 @@
+Enhancement: Add option to force use of Azure CLI credential
+
+A new environment variable `AZURE_FORCE_CLI_CREDENTIAL=true` allows forcing the use of Azure CLI credential, ignoring other credentials like managed identity.
+
+https://github.com/restic/restic/pull/4799

changelog/0.17.0_2024-07-26/issue-1786

@@ -0,0 +1,20 @@
+Enhancement: Support repositories with empty password
+
+Restic previously required a password to create or operate on repositories.
+Using the new option `--insecure-no-password` it is now possible to disable
+this requirement. Restic will not prompt for a password when using this option.
+
+For security reasons, the option must always be specified when operating on
+repositories with an empty password, and specifying `--insecure-no-password`
+while also passing a password to restic via a CLI option or environment
+variable results in an error.
+
+The `init` and `copy` commands add the related `--from-insecure-no-password`
+option, which applies to the source repository. The `key add` and `key passwd`
+commands add the `--new-insecure-no-password` option to add or set an empty
+password.
+
+https://github.com/restic/restic/issues/1786
+https://github.com/restic/restic/issues/4326
+https://github.com/restic/restic/pull/4698
+https://github.com/restic/restic/pull/4808

changelog/0.17.0_2024-07-26/issue-2348

@@ -0,0 +1,12 @@
+Enhancement: Add `--delete` option to `restore` command
+
+The `restore` command now supports a `--delete` option that allows removing
+files and directories from the target directory that do not exist in the
+snapshot. This option also allows files in the snapshot to replace non-empty
+directories having the same name.
+
+To check that only expected files are deleted, add the `--dry-run --verbose=2`
+options.
+
+https://github.com/restic/restic/issues/2348
+https://github.com/restic/restic/pull/4881

changelog/0.17.0_2024-07-26/issue-3600

@@ -0,0 +1,11 @@
+Bugfix: Handle unreadable xattrs in folders above `backup` source
+
+When backup sources are specified using absolute paths, `backup` also includes
+information about the parent folders of the backup sources in the snapshot.
+
+If the extended attributes for some of these folders could not be read due to
+missing permissions, this caused the backup to fail. This has now been fixed.
+
+https://github.com/restic/restic/issues/3600
+https://github.com/restic/restic/pull/4668
+https://forum.restic.net/t/parent-directories-above-the-snapshot-source-path-fatal-error-permission-denied/7216

changelog/0.17.0_2024-07-26/issue-3806

@@ -0,0 +1,12 @@
+Enhancement: Optimize and make `prune` command resumable
+
+Previously, if the `prune` command was interrupted, a later `prune` run would
+start repacking pack files from the start, as `prune` did not update the index
+while repacking.
+
+The `prune` command now supports resuming interrupted prune runs. The update
+of the repository index has also been optimized to use less memory and only
+rewrite parts of the index that have changed.
+
+https://github.com/restic/restic/issues/3806
+https://github.com/restic/restic/pull/4812

changelog/0.17.0_2024-07-26/issue-4048

@@ -0,0 +1,6 @@
+Enhancement: Add support for FUSE-T with `mount` on macOS
+
+The restic `mount` command now supports creating FUSE mounts using FUSE-T on macOS.
+
+https://github.com/restic/restic/issues/4048
+https://github.com/restic/restic/pull/4825

changelog/0.17.0_2024-07-26/issue-4209

@@ -0,0 +1,7 @@
+Bugfix: Fix slow SFTP upload performance
+
+Since restic 0.12.1, the upload speed of the sftp backend to a remote server
+has regressed significantly. This has now been fixed.
+
+https://github.com/restic/restic/issues/4209
+https://github.com/restic/restic/pull/4782

changelog/0.17.0_2024-07-26/issue-4251

@@ -1,4 +1,4 @@
-Enhancement: Support reading backup from a commands's standard output
+Enhancement: Support reading backup from a command's standard output
 
 The `backup` command now supports the `--stdin-from-command` option. When using
 this option, the arguments to `backup` are interpreted as a command instead of

changelog/0.17.0_2024-07-26/issue-4287

@@ -0,0 +1,12 @@
+Enhancement: Support connection to rest-server using unix socket
+
+Restic now supports using a unix socket to connect to a rest-server
+version 0.13.0 or later. This allows running restic as follows:
+
+```
+rest-server --listen unix:/tmp/rest.socket --data /path/to/data &
+restic -r rest:http+unix:///tmp/rest.socket:/my_backup_repo/ [...]
+```
+
+https://github.com/restic/restic/issues/4287
+https://github.com/restic/restic/pull/4655

changelog/0.17.0_2024-07-26/issue-4437

@@ -0,0 +1,11 @@
+Enhancement: Make `check` command create non-existent cache directory
+
+Previously, if a custom cache directory was specified for the `check` command,
+but the directory did not exist, `check` continued with the cache disabled.
+
+The `check` command now attempts to create the cache directory before
+initializing the cache.
+
+https://github.com/restic/restic/issues/4437
+https://github.com/restic/restic/pull/4805
+https://github.com/restic/restic/pull/4883

changelog/0.17.0_2024-07-26/issue-4472

@@ -1,11 +1,11 @@
-Enhancement: Allow AWS Assume Role to be used for S3 backend
+Enhancement: Support AWS Assume Role for S3 backend
 
 Previously only credentials discovered via the Minio discovery methods
 were used to authenticate.
 
 However, there are many circumstances where the discovered credentials have
 lower permissions and need to assume a specific role. This is now possible
-using the following new environment variables.
+using the following new environment variables:
 
 - RESTIC_AWS_ASSUME_ROLE_ARN
 - RESTIC_AWS_ASSUME_ROLE_SESSION_NAME

changelog/0.17.0_2024-07-26/issue-4540

@@ -1,6 +1,7 @@
 Change: Require at least ARMv6 for ARM binaries
 
-The official release binaries of restic now require at least ARMv6 support for ARM platforms.
+The official release binaries of restic now require
+at least ARMv6 support for ARM platforms.
 
 https://github.com/restic/restic/issues/4540
 https://github.com/restic/restic/pull/4542

changelog/0.17.0_2024-07-26/issue-4547

@@ -0,0 +1,7 @@
+Enhancement: Add `--json` option to `version` command
+
+Restic now supports outputting restic version along with the Go version, OS
+and architecture used to build restic in JSON format using `version --json`.
+
+https://github.com/restic/restic/issues/4547
+https://github.com/restic/restic/pull/4553

changelog/0.17.0_2024-07-26/issue-4549

@@ -0,0 +1,11 @@
+Enhancement: Add `--ncdu` option to `ls` command
+
+NCDU (NCurses Disk Usage) is a tool to analyse disk usage of directories. It has
+an option to save a directory tree and analyse it later.
+
+The `ls` command now supports outputting snapshot information in the NCDU format
+using the `--ncdu` option. Example usage: `restic ls latest --ncdu | ncdu -f -`
+
+https://github.com/restic/restic/issues/4549
+https://github.com/restic/restic/pull/4550
+https://github.com/restic/restic/pull/4911

changelog/0.17.0_2024-07-26/issue-4568

@@ -0,0 +1,16 @@
+Bugfix: Prevent `forget --keep-tags <invalid>` from deleting all snapshots
+
+Running `forget --keep-tags <invalid>`, where `<invalid>` is a tag that does
+not exist in the repository, would remove all snapshots. This is especially
+problematic if the tag name contains a typo.
+
+The `forget` command now fails with an error if all snapshots in a snapshot
+group would be deleted. This prevents the above example from deleting all
+snapshots.
+
+It is possible to temporarily disable the new check by setting the environment
+variable `RESTIC_FEATURES=safe-forget-keep-tags=false`. Note that this feature
+flag will be removed in the next minor restic version.
+
+https://github.com/restic/restic/pull/4568
+https://github.com/restic/restic/pull/4764

changelog/0.17.0_2024-07-26/issue-4583

@@ -0,0 +1,13 @@
+Enhancement: Ignore `s3.storage-class` archive tiers for metadata
+
+Restic used to store all files on S3 using the specified `s3.storage-class`.
+
+Now, restic will only use non-archive storage tiers for metadata, to avoid
+problems when accessing a repository. To restore any data, it is still
+necessary to manually warm up the required data beforehand.
+
+NOTE: There is no official cold storage support in restic, use this option at
+your own risk.
+
+https://github.com/restic/restic/issues/4583
+https://github.com/restic/restic/pull/4584

changelog/0.17.0_2024-07-26/issue-4601

@@ -0,0 +1,9 @@
+Enhancement: Add support for feature flags
+
+Restic now supports feature flags that can be used to enable and disable
+experimental features. The flags can be set using the environment variable
+`RESTIC_FEATURES`. To get a list of currently supported feature flags, use
+the `features` command.
+
+https://github.com/restic/restic/issues/4601
+https://github.com/restic/restic/pull/4666

changelog/0.17.0_2024-07-26/issue-4602

@@ -0,0 +1,22 @@
+Change: Deprecate legacy index format and `s3legacy` repository layout
+
+Support for the legacy index format used by restic before version 0.2.0 has
+been deprecated and will be removed in the next minor restic version. You can
+use `restic repair index` to update the index to the current format.
+
+It is possible to temporarily reenable support for the legacy index format by
+setting the environment variable `RESTIC_FEATURES=deprecate-legacy-index=false`.
+Note that this feature flag will be removed in the next minor restic version.
+
+Support for the `s3legacy` repository layout used for the S3 backend before
+restic 0.7.0 has been deprecated and will be removed in the next minor restic
+version. You can migrate your S3 repository to the current layout using
+`RESTIC_FEATURES=deprecate-s3-legacy-layout=false restic migrate s3_layout`.
+
+It is possible to temporarily reenable support for the `s3legacy` layout by
+setting the environment variable `RESTIC_FEATURES=deprecate-s3-legacy-layout=false`.
+Note that this feature flag will be removed in the next minor restic version.
+
+https://github.com/restic/restic/issues/4602
+https://github.com/restic/restic/pull/4724
+https://github.com/restic/restic/pull/4743

changelog/0.17.0_2024-07-26/issue-4627

@@ -0,0 +1,33 @@
+Change: Redesign backend error handling to improve reliability
+
+Restic now downloads pack files in large chunks instead of using a streaming
+download. This prevents failures due to interrupted streams. The `restore`
+command now also retries downloading individual blobs that could not be
+retrieved.
+
+HTTP requests that are stuck for more than two minutes while uploading or
+downloading are now forcibly interrupted. This ensures that stuck requests are
+retried after a short timeout.
+
+Attempts to access a missing or truncated file will no longer be retried. This
+avoids unnecessary retries in those cases. All other backend requests are
+retried for up to 15 minutes. This ensures that temporarily interrupted network
+connections can be tolerated.
+
+If a download yields a corrupt file or blob, then the download will be retried
+once.
+
+Most parts of the new backend error handling can temporarily be disabled by
+setting the environment variable `RESTIC_FEATURES=backend-error-redesign=false`.
+Note that this feature flag will be removed in the next minor restic version.
+
+https://github.com/restic/restic/issues/4627
+https://github.com/restic/restic/issues/4193
+https://github.com/restic/restic/pull/4605
+https://github.com/restic/restic/pull/4792
+https://github.com/restic/restic/issues/4515
+https://github.com/restic/restic/issues/1523
+https://github.com/restic/restic/pull/4520
+https://github.com/restic/restic/pull/4800
+https://github.com/restic/restic/pull/4784
+https://github.com/restic/restic/pull/4844

changelog/0.17.0_2024-07-26/issue-4656

@@ -1,6 +1,6 @@
-Bugfix: Properly report the ID of newly added keys
+Bugfix: Properly report ID of newly added keys
 
-`restic key add` now reports the ID of a newly added key. This simplifies
+`restic key add` now reports the ID of the newly added key. This simplifies
 selecting a specific key using the `--key-hint key` option.
 
 https://github.com/restic/restic/issues/4656

changelog/0.17.0_2024-07-26/issue-4676

@@ -0,0 +1,8 @@
+Enhancement: Make `key` command's actions separate sub-commands
+
+Each of the `add`, `list`, `remove` and `passwd` actions provided by the `key`
+command is now a separate sub-command and have its own documentation which can
+be invoked using `restic key <add|list|remove|passwd> --help`.
+
+https://github.com/restic/restic/issues/4676
+https://github.com/restic/restic/pull/4685

changelog/0.17.0_2024-07-26/issue-4678

@@ -0,0 +1,8 @@
+Enhancement: Add `--target` option to the `dump` command
+
+Restic `dump` always printed to the standard output. It now supports specifying
+a `--target` file to write its output to.
+
+https://github.com/restic/restic/issues/4678
+https://github.com/restic/restic/pull/4682
+https://github.com/restic/restic/pull/4692

changelog/0.17.0_2024-07-26/issue-4707

@@ -0,0 +1,14 @@
+Change: Disable S3 anonymous authentication by default
+
+When using the S3 backend with anonymous authentication, it continuously
+tried to retrieve new authentication credentials, causing bad performance.
+
+Now, to use anonymous authentication, it is necessary to pass the extended
+option `-o s3.unsafe-anonymous-auth=true` to restic.
+
+It is possible to temporarily revert to the old behavior by setting the
+environment variable `RESTIC_FEATURES=explicit-s3-anonymous-auth=false`. Note
+that this feature flag will be removed in the next minor restic version.
+
+https://github.com/restic/restic/issues/4707
+https://github.com/restic/restic/pull/4908

changelog/0.17.0_2024-07-26/issue-4733

@@ -0,0 +1,12 @@
+Enhancement: Allow specifying `--host` via environment variable
+
+Restic commands that operate on snapshots, such as `restic backup` and
+`restic snapshots`, support the `--host` option to specify the hostname
+for grouping snapshots.
+
+Such commands now also support specifying the hostname via the environment
+variable `RESTIC_HOST`. Note that `--host` still takes precedence over the
+environment variable.
+
+https://github.com/restic/restic/issues/4733
+https://github.com/restic/restic/pull/4734

changelog/0.17.0_2024-07-26/issue-4744

@@ -0,0 +1,9 @@
+Change: Include full key ID in JSON output of `key list`
+
+The JSON output of the `key list` command has changed to include the full key
+ID instead of just a shortened version of the ID, as the latter can be ambiguous
+in some rare cases. To derive the short ID, please truncate the full ID down to
+eight characters.
+
+https://github.com/restic/restic/issues/4744
+https://github.com/restic/restic/pull/4745

changelog/0.17.0_2024-07-26/issue-4760

@@ -0,0 +1,8 @@
+Bugfix: Fix possible error on concurrent cache cleanup
+
+If multiple restic processes concurrently cleaned up no longer existing files
+from the cache, this could cause some of the processes to fail with an `no such
+file or directory` error. This has now been fixed.
+
+https://github.com/restic/restic/issues/4760
+https://github.com/restic/restic/pull/4761

changelog/0.17.0_2024-07-26/issue-4768

@@ -0,0 +1,8 @@
+Enhancement: Allow specifying custom User-Agent for outgoing requests
+
+Restic now supports setting a custom `User-Agent` for outgoing HTTP requests
+using the global option `--http-user-agent` or the `RESTIC_HTTP_USER_AGENT`
+environment variable.
+
+https://github.com/restic/restic/issues/4768
+https://github.com/restic/restic/pull/4810

changelog/0.17.0_2024-07-26/issue-4781

@@ -0,0 +1,8 @@
+Enhancement: Add `restore` options to read include/exclude patterns from files
+
+Restic now supports reading include and exclude patterns from files using the 
+`--include-file`, `--exclude-file`, `--iinclude-file` and `--iexclude-file` 
+options of the `restore` command.
+
+https://github.com/restic/restic/issues/4781
+https://github.com/restic/restic/pull/4811

changelog/0.17.0_2024-07-26/issue-4817

@@ -0,0 +1,26 @@
+Enhancement: Make overwrite behavior of `restore` customizable
+
+The `restore` command now supports an `--overwrite` option to configure whether
+already existing files are overwritten. The overwrite behavior can be configured
+using the following option values:
+
+- `--overwrite always` (default): Always overwrites already existing files.
+  The `restore` command will verify the existing file content and only restore
+  mismatching parts to minimize downloads. Updates the metadata of all files.
+- `--overwrite if-changed`: Like `always`, but speeds up the file content check
+  by assuming that files with matching size and modification time (mtime) are
+  already up to date. In case of a mismatch, the full file content is verified
+  like with `always`. Updates the metadata of all files.
+- `--overwrite if-newer`: Like `always`, but only overwrites existing files
+  when the file in the snapshot has a newer modification time (mtime) than the
+  existing file.
+- `--overwrite never`: Never overwrites existing files.
+
+https://github.com/restic/restic/issues/4817
+https://github.com/restic/restic/issues/200
+https://github.com/restic/restic/issues/407
+https://github.com/restic/restic/issues/2662
+https://github.com/restic/restic/pull/4837
+https://github.com/restic/restic/pull/4838
+https://github.com/restic/restic/pull/4864
+https://github.com/restic/restic/pull/4921

changelog/0.17.0_2024-07-26/issue-4850

@@ -0,0 +1,8 @@
+Bugfix: Handle UTF-16 password files in `key` command correctly
+
+Previously, `key add` and `key passwd` did not properly decode UTF-16
+encoded passwords read from a password file. This has now been fixed
+to correctly match the encoding when opening a repository.
+
+https://github.com/restic/restic/issues/4850
+https://github.com/restic/restic/pull/4851

changelog/0.17.0_2024-07-26/issue-4902

@@ -0,0 +1,8 @@
+Bugfix: Update snapshot summary on `rewrite`
+
+Restic previously did not recalculate the total number of files and bytes
+processed when files were excluded from a snapshot by the `rewrite` command.
+This has now been fixed.
+
+https://github.com/restic/restic/issues/4902
+https://github.com/restic/restic/pull/4905

changelog/0.17.0_2024-07-26/issue-662

@@ -0,0 +1,11 @@
+Enhancement: Optionally skip snapshot creation if nothing changed
+
+The `backup` command always created a snapshot even if nothing in the
+backup set changed compared to the parent snapshot.
+
+Restic now supports the `--skip-if-unchanged` option for the `backup`
+command, which omits creating a snapshot if the new snapshot's content
+would be identical to that of the parent snapshot.
+
+https://github.com/restic/restic/issues/662
+https://github.com/restic/restic/pull/4816

changelog/0.17.0_2024-07-26/issue-693

@@ -0,0 +1,13 @@
+Enhancement: Include snapshot size in `snapshots` output
+
+The `snapshots` command now prints the size for snapshots created using this
+or a future restic version. To achieve this, the `backup` command now stores
+the backup summary statistics in the snapshot.
+
+The text output of the `snapshots` command only shows the snapshot size. The
+other statistics are only included in the JSON output. To inspect these
+statistics use `restic snapshots --json` or `restic cat snapshot <snapshotID>`.
+
+https://github.com/restic/restic/issues/693
+https://github.com/restic/restic/pull/4705
+https://github.com/restic/restic/pull/4913

changelog/0.17.0_2024-07-26/issue-828

@@ -0,0 +1,11 @@
+Enhancement: Improve features of the `repair packs` command
+
+The `repair packs` command has been improved to also be able to process
+truncated pack files. The `check` and `check --read-data` command will provide
+instructions on using the command if necessary to repair a repository. See the
+guide at https://restic.readthedocs.io/en/stable/077_troubleshooting.html for
+further instructions.
+
+https://github.com/restic/restic/issues/828
+https://github.com/restic/restic/pull/4644
+https://github.com/restic/restic/pull/4882

changelog/0.17.0_2024-07-26/pull-3067

@@ -0,0 +1,25 @@
+Enhancement: Add extended options to configure Windows Shadow Copy Service
+
+Previous, restic always used a 120 seconds timeout and unconditionally created
+VSS snapshots for all volume mount points on disk. This behavior can now be
+fine-tuned by the following new extended options (available only on Windows):
+
+- `-o vss.timeout`: Time that VSS can spend creating snapshot before timing out (default: 120s)
+- `-o vss.exclude-all-mount-points`: Exclude mountpoints from snapshotting on all volumes (default: false)
+- `-o vss.exclude-volumes`: Semicolon separated list of volumes to exclude from snapshotting
+- `-o vss.provider`: VSS provider identifier which will be used for snapshotting
+
+For example, change VSS timeout to five minutes and disable snapshotting of
+mount points on all volumes:
+
+    restic backup --use-fs-snapshot -o vss.timeout=5m -o vss.exclude-all-mount-points=true
+
+Exclude drive `d:`, mount point `c:\mnt` and a specific volume from snapshotting:
+
+    restic backup --use-fs-snapshot -o vss.exclude-volumes="d:\;c:\mnt\;\\?\Volume{e2e0315d-9066-4f97-8343-eb5659b35762}"
+
+Uses 'Microsoft Software Shadow Copy provider 1.0' instead of the default provider:
+
+    restic backup --use-fs-snapshot -o vss.provider={b5946137-7b9f-4925-af80-51abd60b20d5}
+
+https://github.com/restic/restic/pull/3067

changelog/0.17.0_2024-07-26/pull-4006

@@ -0,0 +1,15 @@
+Enhancement: (alpha) Store deviceID only for hardlinks
+
+Set `RESTIC_FEATURES=device-id-for-hardlinks` to enable this alpha feature.
+The feature flag will be removed after repository format version 3 becomes
+available or be replaced with a different solution.
+
+When creating backups from a filesystem snapshot, for example created using
+BTRFS subvolumes, the deviceID of the filesystem changes compared to previous
+snapshots. This prevented restic from deduplicating the directory metadata of
+a snapshot.
+
+When this alpha feature is enabled, the deviceID is only stored for hardlinks,
+which significantly reduces the metadata duplication for most backups.
+
+https://github.com/restic/restic/pull/4006

changelog/0.17.0_2024-07-26/pull-4354

@@ -0,0 +1,7 @@
+Enhancement: Significantly reduce `prune` memory usage
+
+The `prune` command has been optimized to use up to 60% less memory.
+The memory usage should now be roughly similar to creating a backup.
+
+https://github.com/restic/restic/pull/4354
+https://github.com/restic/restic/pull/4812

changelog/0.17.0_2024-07-26/pull-4503

@@ -0,0 +1,8 @@
+Bugfix: Correct hardlink handling in `stats` command
+
+If files on different devices had the same inode ID, the `stats` command
+did not correctly calculate the snapshot size. This has now been fixed.
+
+https://forum.restic.net/t/possible-bug-in-stats/6461/8
+https://github.com/restic/restic/pull/4503
+https://github.com/restic/restic/pull/4006

changelog/0.17.0_2024-07-26/pull-4526

@@ -0,0 +1,12 @@
+Enhancement: Add bitrot detection to `diff` command
+
+The output of the `diff` command now includes the modifier `?` for files to
+indicate bitrot in backed up files. The `?` will appear whenever there is a
+difference in content while the metadata is exactly the same.
+
+Since files with unchanged metadata are normally not read again when creating
+a backup, the detection is only effective when the right-hand side of the diff
+has been created with `backup --force`.
+
+https://github.com/restic/restic/issues/805
+https://github.com/restic/restic/pull/4526

changelog/0.17.0_2024-07-26/pull-4573

@@ -0,0 +1,6 @@
+Enhancement: Support rewriting host and time metadata in snapshots
+
+The `rewrite` command now supports rewriting the host and/or time metadata of
+a snapshot using the new `--new-host` and `--new-time` options.
+
+https://github.com/restic/restic/pull/4573

changelog/0.17.0_2024-07-26/pull-4590

@@ -0,0 +1,6 @@
+Enhancement: Speed up `mount` command's error detection
+
+The `mount` command now checks for the existence of the mountpoint before
+opening the repository, leading to quicker error detection.
+
+https://github.com/restic/restic/pull/4590

changelog/0.17.0_2024-07-26/pull-4611

@@ -0,0 +1,9 @@
+Enhancement: Back up more file metadata on Windows
+
+Previously, restic did not back up all common Windows-specific metadata.
+
+Restic now stores file creation time and file attributes like the hidden,
+read-only and encrypted flags when backing up files and folders on Windows.
+
+https://github.com/restic/restic/pull/4611
+

changelog/0.17.0_2024-07-26/pull-4615

@@ -1,6 +1,6 @@
-Bugfix: `find` ignored directories in some cases
+Bugfix: Make `find` not sometimes ignore directories
 
 In some cases, the `find` command ignored empty or moved directories. This has
-been fixed.
+now been fixed.
 
 https://github.com/restic/restic/pull/4615

changelog/0.17.0_2024-07-26/pull-4664

@@ -0,0 +1,10 @@
+Enhancement: Make `ls` use `message_type` field in JSON output
+
+The `ls` command was the only restic command that used the `struct_type` field
+in its JSON output format to specify the message type.
+
+The JSON output of the `ls` command now also includes the `message_type` field,
+which is consistent with other commands. The `struct_type` field is still
+included, but now deprecated.
+
+https://github.com/restic/restic/pull/4664

changelog/0.17.0_2024-07-26/pull-4703

@@ -0,0 +1,11 @@
+Bugfix: Shutdown cleanly when receiving SIGTERM
+
+Previously, when restic received the SIGTERM signal it would terminate
+immediately, skipping cleanup and potentially causing issues like stale locks
+being left behind. This primarily effected containerized restic invocations
+that use SIGTERM, but could also be triggered via a simple `killall restic`.
+
+This has now been fixed, such that restic shuts down cleanly when receiving
+the SIGTERM signal.
+
+https://github.com/restic/restic/pull/4703

changelog/0.17.0_2024-07-26/pull-4708

@@ -0,0 +1,13 @@
+Enhancement: Back up and restore SecurityDescriptors on Windows
+
+Restic now backs up and restores SecurityDescriptors for files and folders on
+Windows which includes owner, group, discretionary access control list (DACL)
+and system access control list (SACL).
+
+This requires the user to be a member of backup operators or the application
+must be run as admin. If that is not the case, only the current user's owner,
+group and DACL will be backed up, and during restore only the DACL of the
+backed up file will be restored, with the current user's owner and group
+being set on the restored file.
+
+https://github.com/restic/restic/pull/4708

changelog/0.17.0_2024-07-26/pull-4709

@@ -0,0 +1,10 @@
+Bugfix: Correct `--no-lock` handling of `ls` and `tag` commands
+
+The `ls` command never locked the repository. This has now been fixed, with the
+old behavior still being supported using `ls --no-lock`. The latter invocation
+also works with older restic versions.
+
+The `tag` command erroneously accepted the `--no-lock` command. This command
+now always requires an exclusive lock.
+
+https://github.com/restic/restic/pull/4709

changelog/0.17.0_2024-07-26/pull-4737

@@ -0,0 +1,6 @@
+Enhancement: Include snapshot ID in `reason` field of `forget` JSON output
+
+The JSON output of the `forget` command now includes `id` and `short_id` of
+snapshots in the `reason` field.
+
+https://github.com/restic/restic/pull/4737

changelog/0.17.0_2024-07-26/pull-4764

@@ -0,0 +1,10 @@
+Enhancement: Support forgetting all snapshots
+
+The `forget` command now supports the `--unsafe-allow-remove-all` option, which
+removes all snapshots in the repository.
+
+This option must always be combined with a snapshot filter (by host, path or
+tag). For example, the command `forget --tag example --unsafe-allow-remove-all`
+removes all snapshots with the tag "example".
+
+https://github.com/restic/restic/pull/4764

changelog/0.17.0_2024-07-26/pull-4796

@@ -0,0 +1,8 @@
+Enhancement: Improve `dump` performance for large files
+
+The `dump` command now retrieves the data chunks for a file in
+parallel. This improves the download performance by up to as many
+times as the configured number of parallel backend connections.
+
+https://github.com/restic/restic/issues/3406
+https://github.com/restic/restic/pull/4796

changelog/0.17.0_2024-07-26/pull-4807

@@ -0,0 +1,6 @@
+Enhancement: Support Extended Attributes on Windows NTFS
+
+Restic now backs up and restores Extended Attributes for files
+and folders on Windows NTFS.
+
+https://github.com/restic/restic/pull/4807

changelog/0.17.0_2024-07-26/pull-4839

@@ -0,0 +1,7 @@
+Enhancement: Add dry-run support to `restore` command
+
+The `restore` command now supports the `--dry-run` option to perform
+a dry run. Pass the `--verbose=2` option to see which files would
+remain unchanged, and which would be updated or freshly restored.
+
+https://github.com/restic/restic/pull/4839

changelog/0.17.0_2024-07-26/pull-4884

@@ -0,0 +1,11 @@
+Change: Return exit code 10 and 11 for non-existing and locked repository
+
+If a repository does not exist or cannot be locked, restic previously always
+returned exit code 1. This made it difficult to distinguish these cases from
+other errors.
+
+Restic now returns exit code 10 if the repository does not exist, and exit code
+11 if the repository could be not locked due to a conflicting lock.
+
+https://github.com/restic/restic/issues/956
+https://github.com/restic/restic/pull/4884

changelog/0.17.1_2024-09-05/issue-2004

@@ -0,0 +1,18 @@
+Bugfix: Correctly handle volume names in `backup` command on Windows
+
+On Windows, when the specified backup target only included the volume
+name without a trailing slash, for example, `C:`, then restoring the
+resulting snapshot would result in an error. Note that using `C:\`
+as backup target worked correctly.
+
+Specifying volume names is now handled correctly. To restore snapshots
+created before this bugfix, use the <snapshot>:<subpath> syntax. For
+example, to restore a snapshot with ID `12345678` that backed up `C:`,
+use the following command:
+
+```
+restic restore 12345678:/C/C:./ --target output/folder
+```
+
+https://github.com/restic/restic/issues/2004
+https://github.com/restic/restic/pull/5028

changelog/0.17.1_2024-09-05/issue-4795

@@ -0,0 +1,8 @@
+Enhancement: Display progress bar for `restore --verify`
+
+When the `restore` command is run with `--verify`, it now displays a progress
+bar while the verification step is running. The progress bar is not shown when
+the `--json` flag is specified.
+
+https://github.com/restic/restic/issues/4795
+https://github.com/restic/restic/pull/4989

changelog/0.17.1_2024-09-05/issue-4934

@@ -0,0 +1,11 @@
+Enhancement: Automatically clear removed snapshots from cache
+
+Previously, restic only removed snapshots from the cache on the host where the
+`forget` command was executed. On other hosts that use the same repository, the
+old snapshots remained in the cache.
+
+Restic now automatically clears old snapshots from the local cache of the
+current host.
+
+https://github.com/restic/restic/issues/4934
+https://github.com/restic/restic/pull/4981

changelog/0.17.1_2024-09-05/issue-4944

@@ -0,0 +1,9 @@
+Enhancement: Print JSON-formatted errors during `restore --json`
+
+Restic used to print any `restore` errors directly to the console as freeform
+text messages, even when using the `--json` option.
+
+Now, when `--json` is specified, restic prints them as JSON formatted messages.
+
+https://github.com/restic/restic/issues/4944
+https://github.com/restic/restic/pull/4946

changelog/0.17.1_2024-09-05/issue-4945

@@ -0,0 +1,10 @@
+Bugfix: Include missing backup error text with `--json`
+
+Previously, when running a backup with the `--json` option, restic failed to
+include the actual error message in the output, resulting in `"error": {}`
+being displayed.
+
+This has now been fixed, and restic now includes the error text in JSON output.
+
+https://github.com/restic/restic/issues/4945
+https://github.com/restic/restic/pull/4946

changelog/0.17.1_2024-09-05/issue-4953

@@ -0,0 +1,7 @@
+Bugfix: Correctly handle long paths on older Windows versions
+
+On older Windows versions, like Windows Server 2012, restic 0.17.0 failed to
+back up files with long paths. This problem has now been resolved.
+
+https://github.com/restic/restic/issues/4953
+https://github.com/restic/restic/pull/4954

changelog/0.17.1_2024-09-05/issue-4957

@@ -0,0 +1,8 @@
+Bugfix: Fix delayed cancellation of certain commands
+
+Since restic 0.17.0, some commands did not immediately respond to cancellation
+via Ctrl-C (SIGINT) and continued running for a short period. The most affected
+commands were `diff`,`find`, `ls`, `stats` and `rewrite`. This is now resolved.
+
+https://github.com/restic/restic/issues/4957
+https://github.com/restic/restic/pull/4960

changelog/0.17.1_2024-09-05/issue-4969

@@ -0,0 +1,7 @@
+Bugfix: Correctly restore timestamp for files with resource forks on macOS
+
+On macOS, timestamps were not restored for files with resource forks. This has
+now been fixed.
+
+https://github.com/restic/restic/issues/4969
+https://github.com/restic/restic/pull/5006

changelog/0.17.1_2024-09-05/issue-4970

@@ -0,0 +1,15 @@
+Enhancement: Make timeout for stuck requests customizable
+
+Restic monitors connections to the backend to detect stuck requests. If a
+request does not return any data within five minutes, restic assumes the
+request is stuck and retries it. However, for large repositories this timeout
+might be insufficient to collect a list of all files, causing the following
+error:
+
+`List(data) returned error, retrying after 1s: [...]: request timeout`
+
+It is now possible to increase the timeout using the `--stuck-request-timeout`
+option.
+
+https://github.com/restic/restic/issues/4970
+https://github.com/restic/restic/pull/5014

changelog/0.17.1_2024-09-05/issue-4975

@@ -0,0 +1,7 @@
+Bugfix: Prevent `backup --stdin-from-command` from panicking
+
+Restic would previously crash if `--stdin-from-command` was specified without
+providing a command. This issue has now been fixed.
+
+https://github.com/restic/restic/issues/4975
+https://github.com/restic/restic/pull/4976

changelog/0.17.1_2024-09-05/issue-5004

@@ -0,0 +1,12 @@
+Bugfix: Fix spurious "A Required Privilege Is Not Held by the Client" error
+
+On Windows, creating a backup could sometimes trigger the following error:
+
+```
+error: nodeFromFileInfo [...]: get named security info failed with: a required privilege is not held by the client.
+```
+
+This has now been fixed.
+
+https://github.com/restic/restic/issues/5004
+https://github.com/restic/restic/pull/5019

changelog/0.17.1_2024-09-05/issue-5005

@@ -0,0 +1,16 @@
+Bugfix: Fix rare failures to retry locking a repository
+
+Restic 0.17.0 could in rare cases fail to retry locking a repository if one of
+the lock files failed to load, resulting in the error:
+
+```
+unable to create lock in backend: circuit breaker open for file <lock/1234567890>
+```
+
+This issue has now been addressed. The error handling now properly retries the
+locking operation. In addition, restic waits a few seconds between locking
+retries to increase chances of successful locking.
+
+https://github.com/restic/restic/issues/5005
+https://github.com/restic/restic/pull/5011
+https://github.com/restic/restic/pull/5012

changelog/0.17.1_2024-09-05/pull-4958

@@ -0,0 +1,7 @@
+Bugfix: Don't ignore metadata-setting errors during restore
+
+Previously, restic used to ignore errors when setting timestamps, attributes,
+or file modes during a restore. It now reports those errors, except for
+permission related errors when running without root privileges.
+
+https://github.com/restic/restic/pull/4958

changelog/0.17.1_2024-09-05/pull-4959

@@ -0,0 +1,6 @@
+Enhancement: Return exit code 12 for "bad password" errors
+
+Restic now returns exit code 12 when it cannot open the repository due to an
+incorrect password.
+
+https://github.com/restic/restic/pull/4959

changelog/0.17.1_2024-09-05/pull-4977

@@ -0,0 +1,16 @@
+Change: Also back up files with incomplete metadata
+
+If restic failed to read extended metadata for a file or folder during a
+backup, then the file or folder was not included in the resulting snapshot.
+Instead, a warning message was printed along with returning exit code 3 once
+the backup was finished.
+
+Now, restic also includes items for which the extended metadata could not be
+read in a snapshot. The warning message has been updated to:
+
+```
+incomplete metadata for /path/to/file: <details about error>
+```
+
+https://github.com/restic/restic/issues/4953
+https://github.com/restic/restic/pull/4977

changelog/0.17.1_2024-09-05/pull-4980

@@ -0,0 +1,12 @@
+Bugfix: Skip extended attribute processing on unsupported Windows volumes
+
+With restic 0.17.0, backups of certain Windows paths, such as network drives,
+failed due to errors while fetching extended attributes.
+
+Restic now skips extended attribute processing for volumes where they are not
+supported.
+
+https://github.com/restic/restic/pull/4980
+https://github.com/restic/restic/pull/4998
+https://github.com/restic/restic/issues/4955
+https://github.com/restic/restic/issues/4950

changelog/0.17.1_2024-09-05/pull-5018

@@ -0,0 +1,13 @@
+Bugfix: Improve HTTP/2 support for REST backend
+
+If `rest-server` tried to gracefully shut down an HTTP/2 connection still in
+use by the client, it could result in the following error:
+
+```
+http2: Transport: cannot retry err [http2: Transport received Server's graceful shutdown GOAWAY] after Request.Body was written; define Request.GetBody to avoid this error
+```
+
+This issue has now been resolved.
+
+https://github.com/restic/restic/pull/5018
+https://forum.restic.net/t/receiving-http2-goaway-messages-with-windows-restic-v0-17-0/8367

changelog/0.17.2_2024-10-27/issue-4004

@@ -0,0 +1,12 @@
+Bugfix: Support container-level SAS/SAT tokens for Azure backend
+
+Restic previously expected SAS/SAT tokens to be generated at the account level,
+which prevented tokens created at the container level from being used to
+initialize a repository. This caused an error when attempting to initialize a
+repository with container-level tokens.
+
+Restic now supports both account-level and container-level SAS/SAT tokens for
+initializing a repository.
+
+https://github.com/restic/restic/issues/4004
+https://github.com/restic/restic/pull/5093

changelog/0.17.2_2024-10-27/issue-5050

@@ -0,0 +1,7 @@
+Bugfix: Return error if `tag` fails to lock repository
+
+Since restic 0.17.0, the `tag` command did not return an error when it failed
+to open or lock the repository. This issue has now been fixed.
+
+https://github.com/restic/restic/issues/5050
+https://github.com/restic/restic/pull/5056

changelog/0.17.2_2024-10-27/issue-5063

@@ -0,0 +1,12 @@
+Bugfix: Correctly `backup` extended metadata when using VSS on Windows
+
+On Windows, when creating a backup with the `--use-fs-snapshot` option, restic
+read extended metadata from the original filesystem path instead of from the
+snapshot. This could result in errors if files were removed during the backup
+process.
+
+This issue has now been resolved.
+
+https://github.com/restic/restic/issues/5063
+https://github.com/restic/restic/pull/5097
+https://github.com/restic/restic/pull/5099

changelog/0.17.2_2024-10-27/pull-5047

@@ -0,0 +1,8 @@
+Bugfix: Resolve potential error during concurrent cache cleanup
+
+When multiple restic processes ran concurrently, they could compete to remove
+obsolete snapshots from the local backend cache, sometimes leading to a "no
+such file or directory" error. Restic now suppresses this error to prevent
+issues during cache cleanup.
+
+https://github.com/restic/restic/pull/5047

changelog/0.17.2_2024-10-27/pull-5057

@@ -0,0 +1,24 @@
+Bugfix: Exclude irregular files from backups
+
+Since restic 0.17.1, files with the type `irregular` could mistakenly be included
+in snapshots, especially when backing up special file types on Windows that
+restic cannot process. This issue has now been fixed.
+
+Previously, this bug caused the `check` command to report errors like the
+following one:
+
+```
+  tree 12345678[...]: node "example.zip" with invalid type "irregular"
+```
+
+To repair affected snapshots, upgrade to restic 0.17.2 and run:
+
+```
+restic repair snapshots --forget
+```
+
+This will remove the `irregular` files from the snapshots (creating
+a new snapshot ID for each of the affected snapshots).
+
+https://github.com/restic/restic/pull/5057
+https://forum.restic.net/t/errors-found-by-check-1-invalid-type-irregular-2-ciphertext-verification-failed/8447/2

changelog/0.17.3_2024-11-08/issue-4971

@@ -0,0 +1,7 @@
+Bugfix: Fix unusable `mount` on macOS Sonoma
+
+On macOS Sonoma when using FUSE-T, it was not possible to access files in
+a mounted repository. This issue is now resolved.
+
+https://github.com/restic/restic/issues/4971
+https://github.com/restic/restic/pull/5048

changelog/0.17.3_2024-11-08/issue-5003

@@ -0,0 +1,14 @@
+Bugfix: Fix metadata errors during backup of removable disks on Windows
+
+Since restic 0.17.0, backing up removable disks on Windows could report
+errors with retrieving metadata like shown below.
+
+```
+error: incomplete metadata for d:\filename: get named security info failed with: Access is denied.
+```
+
+This has now been fixed.
+
+https://github.com/restic/restic/issues/5003
+https://github.com/restic/restic/pull/5123
+https://forum.restic.net/t/backing-up-a-folder-from-a-veracrypt-volume-brings-up-errors-since-restic-v17-0/8444

changelog/0.17.3_2024-11-08/issue-5107

@@ -0,0 +1,15 @@
+Bugfix: Fix metadata error on Windows for backups using VSS
+
+Since restic 0.17.2, when creating a backup on Windows using `--use-fs-snapshot`,
+restic would report an error like the following:
+
+```
+error: incomplete metadata for C:\: get EA failed while opening file handle for path \\?\GLOBALROOT\Device\HarddiskVolumeShadowCopyXX\, with: The process cannot access the file because it is being used by another process.
+```
+
+This has now been fixed by correctly handling paths that refer to volume
+shadow copy snapshots.
+
+https://github.com/restic/restic/issues/5107
+https://github.com/restic/restic/pull/5110
+https://github.com/restic/restic/pull/5112

changelog/0.17.3_2024-11-08/pull-5096

@@ -0,0 +1,8 @@
+Enhancement: Allow `prune --dry-run` without lock
+
+The `prune --dry-run --no-lock` now allows performing a dry-run
+without locking the repository. Note that if the repository is
+modified concurrently, `prune` may return inaccurate statistics
+or errors.
+
+https://github.com/restic/restic/pull/5096

changelog/0.17.3_2024-11-08/pull-5101

@@ -0,0 +1,8 @@
+Bugfix: Do not retry load/list operation if SFTP connection is broken
+
+When using restic with the SFTP backend, backend operations that load a
+file or list files were retried even if the SFTP connection was broken.
+This has now been fixed.
+
+https://github.com/restic/restic/pull/5101
+https://forum.restic.net/t/restic-hanging-on-backup/8559

changelog/0.18.0_2025-03-27/issue-1378

@@ -0,0 +1,7 @@
+Enhancement: Add JSON support to `check` command
+
+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

changelog/0.18.0_2025-03-27/issue-1843

@@ -0,0 +1,7 @@
+Bugfix: Correctly restore long filepaths' timestamp on old Windows
+
+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

changelog/0.18.0_2025-03-27/issue-2165

@@ -0,0 +1,13 @@
+Bugfix: Ignore disappeared backup source files
+
+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
+```
+
+https://github.com/restic/restic/issues/2165
+https://github.com/restic/restic/issues/3098
+https://github.com/restic/restic/pull/5143
+https://github.com/restic/restic/pull/5145

changelog/0.18.0_2025-03-27/issue-2511

@@ -0,0 +1,7 @@
+Enhancement: Support generating shell completions to stdout
+
+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

changelog/0.18.0_2025-03-27/issue-3202

@@ -0,0 +1,11 @@
+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: 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
+https://github.com/restic/restic/issues/2504