Merge 3c3e99848b36c587c8046383ab04e86713061576 into cbb722410c2e876e24abbe8de2cc27693e501dcb

Update README.md (#1977 )
Document that filter doesn't override fetch-depth
2025-06-06 17:02:39 +08:00 · 2024-11-14 10:02:04 -08:00 · 2024-11-14 10:41:00 -05:00 · 2023-10-05 09:04:25 -07:00
2 changed files with 7 additions and 4 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: ''

@ -212,7 +214,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
    repository: my-org/my-tools
    path: my-tools
 ```
-> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
+> - If your secondary repository is private or internal you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)

 ## Checkout multiple repos (nested)

@ -226,7 +228,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
    repository: my-org/my-tools
    path: my-tools
 ```
-> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
+> - If your secondary repository is private or internal you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)

 ## Checkout multiple repos (private)

--- 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	bfc68bdf66	Merge 3c3e99848b36c587c8046383ab04e86713061576 into cbb722410c2e876e24abbe8de2cc27693e501dcb	2024-11-14 10:02:04 -08:00
Mohammad Ismail	cbb722410c	Update README.md (#1977 ) Some checks failed CodeQL / Analyze (javascript) (push) Has been cancelled Details Licensed / Check licenses (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2024-11-14 10:41:00 -05:00
Jake Bailey	3c3e99848b	Document that filter doesn't override fetch-depth	2023-10-05 09:04:25 -07:00