Merge pull request #25 from buildkite-plugins/SUP-5229-optimize-clean-checkout

Optimize clean_checkout workflow

Author: petetomasik

README.md

@@ -26,7 +26,13 @@ Whether to skip ssh-keyscan step. This will skip adding each ssh public key into
 
 #### `clean_checkout` ('true' or 'false')
 
-Whether to perform aggressive repository cleanup before checkout. This option handles scenarios where interrupted or cancelled jobs leave the git repository in a corrupted state with uncommitted changes that would prevent checkout. When enabled, it performs `git reset --hard HEAD` and `git sparse-checkout disable` in addition to the normal cleanup.
+Whether to perform aggressive repository cleanup before checkout. This option handles scenarios where interrupted or cancelled jobs leave the git repository in a corrupted state that would prevent checkout. When enabled, it removes git lock files, resets the repository with `git reset --hard HEAD`, and cleans all untracked files with `git clean -ffxdq`.
+
+**What it fixes:**
+- Stale git lock files (from interrupted operations)
+- Corrupted git index
+- Uncommitted changes in tracked files
+- Untracked and ignored files
 
 **⚠️ Warning:** This option will destroy ALL local changes and remove ALL untracked files. The `git clean -ffxdq` command with the `-x` flag will also remove ignored files (such as credentials, local configuration, or cache files). Only use this option when you're certain no important local data needs to be preserved.
 

hooks/checkout

@@ -78,20 +78,14 @@ fi
 # Enable clean checkout option to deal with corrupted repository states
 if [[ "${CLEAN_CHECKOUT_OPTION}" = "true" ]]; then
   log_info "Clean checkout enabled - resetting repository state"
-  # Remove index lock files
+  # Remove lock files (prevents "another git process" errors)
   find .git -name "*.lock" -delete 2>/dev/null || true
-  # Reset index if corrupted
-  if ! git status >/dev/null 2>&1; then
-    rm -f .git/index 2>/dev/null || true
-  fi
-  # Disable sparse-checkout
-  git sparse-checkout disable 2>/dev/null || true
-  # Clean and reset
-  git clean -ffxdq
-
-  if git rev-parse --verify HEAD >/dev/null 2>&1; then
-    git reset --hard HEAD
-  fi
+  # Reset everything: index, working tree, and tracked files
+  # This handles corrupted index, uncommitted changes, and staged changes
+  git reset --hard HEAD 2>/dev/null || true
+  # Clean untracked and ignored files
+  # Must run AFTER reset to also clean files that were previously tracked
+  git clean -ffxdq 2>/dev/null || true
 else
   git clean -ffxdq
 fi

tests/checkout.bats

@@ -125,11 +125,8 @@ setup() {
   export BUILDKITE_PLUGIN_SPARSE_CHECKOUT_CLEAN_CHECKOUT="true"
 
   stub ssh-keyscan "* : echo 'keyscan'"
-  stub git "status : echo 'status ok'"
-  stub git "sparse-checkout disable : echo 'git sparse-checkout disable'"
-  stub git "clean -ffxdq : echo 'git clean aggressive'"
-  stub git "rev-parse --verify HEAD : echo 'HEAD'"
   stub git "reset --hard HEAD : echo 'git reset hard'"
+  stub git "clean -ffxdq : echo 'git clean aggressive'"
   stub git "fetch --depth 1 origin * : echo 'git fetch'"
   stub git "sparse-checkout set * * : echo 'git sparse-checkout'"
   stub git "checkout * : echo 'checkout'"
@@ -140,7 +137,7 @@ setup() {
   assert_output --partial 'Clean checkout enabled - resetting repository state'
   assert_output --partial 'git reset hard'
   assert_output --partial 'git clean aggressive'
-  assert_output --partial 'git sparse-checkout disable'
+  refute_output --partial 'git sparse-checkout disable'
 
   unstub ssh-keyscan
   unstub git
@@ -150,10 +147,8 @@ setup() {
   export BUILDKITE_PLUGIN_SPARSE_CHECKOUT_CLEAN_CHECKOUT="true"
 
   stub ssh-keyscan "* : echo 'keyscan'"
-  stub git "status : echo 'status ok'"
-  stub git "sparse-checkout disable : echo 'sparse-checkout disable'"
+  stub git "reset --hard HEAD : exit 1"
   stub git "clean -ffxdq : echo 'git clean'"
-  stub git "rev-parse --verify HEAD : exit 1"
   stub git "fetch --depth 1 origin * : echo 'git fetch'"
   stub git "sparse-checkout set * * : echo 'git sparse-checkout'"
   stub git "checkout * : echo 'checkout'"
@@ -163,7 +158,7 @@ setup() {
   assert_success
   assert_output --partial 'Clean checkout enabled - resetting repository state'
   assert_output --partial 'git clean'
-  assert_output --partial 'sparse-checkout disable'
+  refute_output --partial 'sparse-checkout disable'
 
   unstub ssh-keyscan
   unstub git