From 2fabc1d1beb26cbeba1b7c886ef9f3732dd7e821 Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Fri, 9 Jun 2023 15:08:21 +0200 Subject: Add support for sparse checkouts (#1369) * Add support for sparse checkouts * sparse-checkout: optionally turn off cone mode While it _is_ true that cone mode is the default nowadays (mainly for performance reasons: code mode is much faster than non-cone mode), there _are_ legitimate use cases where non-cone mode is really useful. Let's add a flag to optionally disable cone mode. Signed-off-by: Johannes Schindelin * Verify minimum Git version for sparse checkout The `git sparse-checkout` command is available only since Git version v2.25.0. The `actions/checkout` Action actually supports older Git versions than that; As of time of writing, the minimum version is v2.18.0. Instead of raising this minimum version even for users who do not require a sparse checkout, only check for this minimum version specifically when a sparse checkout was asked for. Suggested-by: Tingluo Huang Signed-off-by: Johannes Schindelin * Support sparse checkout/LFS better Instead of fetching all the LFS objects present in the current revision in a sparse checkout, whether they are needed inside the sparse cone or not, let's instead only pull the ones that are actually needed. To do that, let's avoid running that preemptive `git lfs fetch` call in case of a sparse checkout. An alternative that was considered during the development of this patch (and ultimately rejected) was to use `git lfs pull --include ...`, but it turned out to be too inflexible because it requires exact paths, not the patterns that are available via the sparse checkout definition, and that risks running into command-line length limitations. Signed-off-by: Johannes Schindelin --------- Signed-off-by: Johannes Schindelin Co-authored-by: Daniel --- __test__/verify-sparse-checkout.sh | 63 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100755 __test__/verify-sparse-checkout.sh (limited to '__test__/verify-sparse-checkout.sh') diff --git a/__test__/verify-sparse-checkout.sh b/__test__/verify-sparse-checkout.sh new file mode 100755 index 0000000..f668430 --- /dev/null +++ b/__test__/verify-sparse-checkout.sh @@ -0,0 +1,63 @@ +#!/bin/sh + +# Verify .git folder +if [ ! -d "./sparse-checkout/.git" ]; then + echo "Expected ./sparse-checkout/.git folder to exist" + exit 1 +fi + +# Verify sparse-checkout +cd sparse-checkout + +SPARSE=$(git sparse-checkout list) + +if [ "$?" != "0" ]; then + echo "Failed to validate sparse-checkout" + exit 1 +fi + +# Check that sparse-checkout list is not empty +if [ -z "$SPARSE" ]; then + echo "Expected sparse-checkout list to not be empty" + exit 1 +fi + +# Check that all folders of the sparse checkout exist +for pattern in $SPARSE +do + if [ ! -d "$pattern" ]; then + echo "Expected directory '$pattern' to exist" + exit 1 + fi +done + +checkSparse () { + if [ ! -d "./$1" ]; then + echo "Expected directory '$1' to exist" + exit 1 + fi + + for file in $(git ls-tree -r --name-only HEAD $1) + do + if [ ! -f "$file" ]; then + echo "Expected file '$file' to exist" + exit 1 + fi + done +} + +# Check that all folders and their children have been checked out +checkSparse __test__ +checkSparse .github +checkSparse dist + +# Check that only sparse-checkout folders have been checked out +for pattern in $(git ls-tree --name-only HEAD) +do + if [ -d "$pattern" ]; then + if [[ "$pattern" != "__test__" && "$pattern" != ".github" && "$pattern" != "dist" ]]; then + echo "Expected directory '$pattern' to not exist" + exit 1 + fi + fi +done \ No newline at end of file -- cgit v1.2.3