Skip to content

Commit 5de0a4c

Browse files
committed
Update README
1 parent c5973c9 commit 5de0a4c

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,13 @@ Whether to skip ssh-keyscan step. This will skip adding each ssh public key into
2626

2727
#### `clean_checkout` ('true' or 'false')
2828

29-
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.
29+
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`.
30+
31+
**What it fixes:**
32+
- Stale git lock files (from interrupted operations)
33+
- Corrupted git index
34+
- Uncommitted changes in tracked files
35+
- Untracked and ignored files
3036

3137
**⚠️ 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.
3238

0 commit comments

Comments
 (0)