Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that filter doesn't override fetch-depth #1505

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: ''

Expand Down
5 changes: 3 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: >
Expand Down