Disable extensions.worktreeConfig when disabling sparse-checkout (#1692)

jww3 · web-flow · commit 43045ae669be · 2024-04-23T22:07:43.000+02:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,7 +8,7 @@ on:
       - releases/*
 
 
-# Note that when you see patterns like "ref: test-data/v2/basic" within this workflow, 
+# Note that when you see patterns like "ref: test-data/v2/basic" within this workflow,
 # these refer to "test-data" branches on this actions/checkout repo.
 # (For example, test-data/v2/basic -> https://github.com/actions/checkout/tree/test-data/v2/basic)
 
@@ -37,7 +37,7 @@ jobs:
     steps:
       # Clone this repo
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.1
 
       # Basic checkout
       - name: Checkout basic
@@ -257,7 +257,7 @@ jobs:
           path: basic
       - name: Verify basic
         run: __test__/verify-basic.sh --archive
-    
+
   test-git-container:
     runs-on: ubuntu-latest
     container: bitnami/git:latest
diff --git a/__test__/verify-basic.sh b/__test__/verify-basic.sh
@@ -18,6 +18,20 @@ else
     exit 1
   fi
 
+  # Verify that sparse-checkout is disabled.
+  SPARSE_CHECKOUT_ENABLED=$(git -C ./basic config --local --get-all core.sparseCheckout)
+  if [ "$SPARSE_CHECKOUT_ENABLED" != "" ]; then
+    echo "Expected sparse-checkout to be disabled (discovered: $SPARSE_CHECKOUT_ENABLED)"
+    exit 1
+  fi
+
+  # Verify git configuration shows worktreeConfig is effectively disabled
+  WORKTREE_CONFIG_ENABLED=$(git -C ./basic config --local --get-all extensions.worktreeConfig)
+  if [[ "$WORKTREE_CONFIG_ENABLED" != "" ]]; then
+    echo "Expected extensions.worktreeConfig (boolean) to be disabled in git config.  This could be an artifact of sparse checkout functionality."
+    exit 1
+  fi
+
   # Verify auth token
   cd basic
   git fetch --no-tags --depth=1 origin +refs/heads/main:refs/remotes/origin/main
diff --git a/dist/index.js b/dist/index.js
@@ -582,6 +582,8 @@ class GitCommandManager {
     disableSparseCheckout() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.execGit(['sparse-checkout', 'disable']);
+            // Disabling 'sparse-checkout` leaves behind an undesirable side-effect in config (even in a pristine environment).
+            yield this.tryConfigUnset('extensions.worktreeConfig', false);
         });
     }
     sparseCheckout(sparseCheckout) {
diff --git a/src/git-command-manager.ts b/src/git-command-manager.ts
@@ -178,6 +178,8 @@ class GitCommandManager {
 
   async disableSparseCheckout(): Promise<void> {
     await this.execGit(['sparse-checkout', 'disable'])
+    // Disabling 'sparse-checkout` leaves behind an undesirable side-effect in config (even in a pristine environment).
+    await this.tryConfigUnset('extensions.worktreeConfig', false)
   }
 
   async sparseCheckout(sparseCheckout: string[]): Promise<void> {

Original file line number	Diff line number	Diff line change
`@@ -582,6 +582,8 @@ class GitCommandManager {`
`582`	`582`	`disableSparseCheckout() {`
`583`	`583`	`return __awaiter(this, void 0, void 0, function* () {`
`584`	`584`	`yield this.execGit(['sparse-checkout', 'disable']);`
	`585`	+ // Disabling 'sparse-checkout` leaves behind an undesirable side-effect in config (even in a pristine environment).
	`586`	`+ yield this.tryConfigUnset('extensions.worktreeConfig', false);`
`585`	`587`	`});`
`586`	`588`	`}`
`587`	`589`	`sparseCheckout(sparseCheckout) {`
Original file line number	Diff line number	Diff line change
`@@ -178,6 +178,8 @@ class GitCommandManager {`
`178`	`178`
`179`	`179`	`async disableSparseCheckout(): Promise<void> {`
`180`	`180`	`await this.execGit(['sparse-checkout', 'disable'])`
	`181`	+ // Disabling 'sparse-checkout` leaves behind an undesirable side-effect in config (even in a pristine environment).
	`182`	`+ await this.tryConfigUnset('extensions.worktreeConfig', false)`
`181`	`183`	`}`
`182`	`184`
`183`	`185`	`async sparseCheckout(sparseCheckout: string[]): Promise<void> {`