From 26d044865990e15712fb05d767ad3b4bb6e64aaa Mon Sep 17 00:00:00 2001
From: Finley Garton <finley.garton@starlingbank.com>
Date: Fri, 8 Sep 2023 17:20:25 +0100
Subject: [PATCH] updated docs to specify override
---
.github/workflows/test.yml | 1 -
README.md | 33 +++++++++++++++++++--------------
action.yml | 6 ++++--
3 files changed, 23 insertions(+), 17 deletions(-)
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 21c4265..15996ee 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -81,7 +81,6 @@ jobs:
- name: Verify fetch filter
run: __test__/verify-fetch-filter.sh
-
# Sparse checkout
- name: Sparse checkout
diff --git a/README.md b/README.md
index de8fe48..e0af453 100644
--- a/README.md
+++ b/README.md
@@ -75,12 +75,12 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
# Default: true
clean: ''
- # Partially clone against a given filter.
+ # Partially clone against a given filter. Overrides sparse-checkout if set.
# Default: null
filter: ''
# Do a sparse checkout on given patterns. Each pattern should be separated with
- # new lines
+ # new lines.
# Default: null
sparse-checkout: ''
@@ -128,18 +128,23 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
# Scenarios
-- [Fetch only the root files](#Fetch-only-the-root-files)
-- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
-- [Fetch only a single file](#Fetch-only-a-single-file)
-- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
-- [Checkout a different branch](#Checkout-a-different-branch)
-- [Checkout HEAD^](#Checkout-HEAD)
-- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
-- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
-- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
-- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
-- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
-- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
+- [Checkout V4](#checkout-v4)
+- [What's new](#whats-new)
+- [Usage](#usage)
+- [Scenarios](#scenarios)
+ - [Fetch only the root files](#fetch-only-the-root-files)
+ - [Fetch only the root files and `.github` and `src` folder](#fetch-only-the-root-files-and-github-and-src-folder)
+ - [Fetch only a single file](#fetch-only-a-single-file)
+ - [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches)
+ - [Checkout a different branch](#checkout-a-different-branch)
+ - [Checkout HEAD^](#checkout-head)
+ - [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side)
+ - [Checkout multiple repos (nested)](#checkout-multiple-repos-nested)
+ - [Checkout multiple repos (private)](#checkout-multiple-repos-private)
+ - [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit)
+ - [Checkout pull request on closed event](#checkout-pull-request-on-closed-event)
+ - [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token)
+- [License](#license)
## Fetch only the root files
diff --git a/action.yml b/action.yml
index 77ea8c7..5aa90a7 100644
--- a/action.yml
+++ b/action.yml
@@ -54,12 +54,14 @@ inputs:
description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
default: true
filter:
- description: 'Partially clone against a given filter.'
+ description: >
+ Partially clone against a given filter.
+ Overrides sparse-checkout if set.
default: null
sparse-checkout:
description: >
Do a sparse checkout on given patterns.
- Each pattern should be separated with new lines
+ Each pattern should be separated with new lines.
default: null
sparse-checkout-cone-mode:
description: >