Document that filter doesn't override fetch-depth

This commit is contained in:
Jake Bailey 2023-10-05 09:04:25 -07:00
parent 8ade135a41
commit 3c3e99848b
2 changed files with 5 additions and 2 deletions

View file

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

View file

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