From 3c3e99848b36c587c8046383ab04e86713061576 Mon Sep 17 00:00:00 2001
From: Jake Bailey <5341706+jakebailey@users.noreply.github.com>
Date: Thu, 5 Oct 2023 09:04:25 -0700
Subject: [PATCH] Document that filter doesn't override fetch-depth

---
 README.md  | 2 ++
 action.yml | 5 +++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 92bc784..c4853f6 100644
--- a/README.md
+++ b/README.md
@@ -76,6 +76,8 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
     clean: ''
 
     # Partially clone against a given filter. Overrides sparse-checkout if set.
+    # Note that when a filter is provided, fetch-depth is still respected; you
+    # may want to specify `fetch-depth: 0` to ensure the full history is fetched.
     # Default: null
     filter: ''
 
diff --git a/action.yml b/action.yml
index 5aa90a7..ac392e1 100644
--- a/action.yml
+++ b/action.yml
@@ -55,8 +55,9 @@ inputs:
     default: true
   filter:
     description: >
-      Partially clone against a given filter.
-      Overrides sparse-checkout if set.
+      Partially clone against a given filter. Overrides sparse-checkout if set.
+      Note that when a filter is provided, fetch-depth is still respected; you
+      may want to specify `fetch-depth: 0` to ensure the full history is fetched.
     default: null
   sparse-checkout:
     description: >