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: >