Merge 3c3e99848b into b684943689

Document that filter doesn't override fetch-depth
2024-11-14 21:08:03 +00:00 · 2024-09-05 10:55:09 -07:00 · 2023-10-05 09:04:25 -07:00
2 changed files with 5 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -79,6 +79,8 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
    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: ''

--- a/action.yml
+++ b/action.yml
@ -59,8 +59,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: >
Author	SHA1	Message	Date
Jake Bailey	5e574c27e5	Merge `3c3e99848b` into `b684943689`	2024-09-05 10:55:09 -07:00
Jake Bailey	3c3e99848b	Document that filter doesn't override fetch-depth	2023-10-05 09:04:25 -07:00