Skip to content

Commit cf8afb7

Browse files
author
Amna Akram
authored
Update README.md
1 parent be03805 commit cf8afb7

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,11 @@ 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. Use this option for pipeline upload jobs that don't need to preserve local changes.
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.
30+
31+
**⚠️ 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.
32+
33+
Use this option for pipeline upload jobs that don't need to preserve local changes.
3034

3135
## Example
3236

0 commit comments

Comments
 (0)