Skip to content

Commit 07e7632

Browse files
docs: update sandbox testing documentation
• Document new reset options and --preserve-config flag • Add examples for resetting from within sandbox • Update TLDR section with new reset commands • Clarify script options and usage patterns
1 parent fce706a commit 07e7632

File tree

1 file changed

+45
-8
lines changed

1 file changed

+45
-8
lines changed

scripts/README.md

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,13 @@ pnpm run test:sandbox:bare
1515
cd .sandbox/*/
1616
node ../../dist/index.js commit
1717

18-
# Quick reset (faster, keeps repo structure)
19-
pnpm run test:sandbox:reset
18+
# Quick reset from within sandbox (easiest!)
19+
bash reset-sandbox.sh # Reset, remove config
20+
bash reset-sandbox.sh --preserve-config # Reset, keep config
21+
22+
# Quick reset from project root
23+
pnpm run test:sandbox:reset # Reset, remove config
24+
bash scripts/labcommitr-sandbox.sh --reset --preserve-config # Reset, keep config
2025

2126
# Full recreation (slower, completely fresh)
2227
pnpm run test:sandbox
@@ -121,17 +126,34 @@ lab commit
121126

122127
### Resetting the Sandbox
123128

124-
You have two reset options:
129+
You have multiple reset options depending on your needs:
125130

126-
**Quick Reset** (recommended for iterative testing)
131+
**Quick Reset from Within Sandbox** (easiest for iterative testing)
127132
```bash
128-
pnpm run test:sandbox:reset
129-
# or
130-
bash scripts/labcommitr-sandbox.sh --reset
133+
# From within the sandbox directory
134+
cd .sandbox/*/
135+
136+
# Reset (removes config file)
137+
bash reset-sandbox.sh
138+
139+
# Reset and preserve config file
140+
bash reset-sandbox.sh --preserve-config
131141
```
142+
- Can be run from within the sandbox directory
132143
- Faster (keeps repository structure)
133144
- Resets git state and re-applies test file changes
134-
- Use this when you want to test again quickly
145+
- Option to preserve `.labcommitr.config.yaml` file
146+
147+
**Quick Reset from Project Root**
148+
```bash
149+
# Reset (removes config file)
150+
pnpm run test:sandbox:reset
151+
152+
# Reset and preserve config file
153+
bash scripts/labcommitr-sandbox.sh --reset --preserve-config
154+
```
155+
- Must be run from project root
156+
- Same functionality as reset from within sandbox
135157

136158
**Full Recreation** (slower but completely fresh)
137159
```bash
@@ -356,13 +378,28 @@ bash scripts/labcommitr-sandbox.sh --no-config
356378
# Quick reset (faster, keeps repo structure)
357379
bash scripts/labcommitr-sandbox.sh --reset
358380

381+
# Quick reset with config preservation
382+
bash scripts/labcommitr-sandbox.sh --reset --preserve-config
383+
359384
# Remove sandbox completely
360385
bash scripts/labcommitr-sandbox.sh --clean
361386

362387
# Show help
363388
bash scripts/labcommitr-sandbox.sh --help
364389
```
365390

391+
**Note:** The script can detect if it's being run from within a sandbox directory and will automatically use that sandbox for reset operations.
392+
393+
### Reset Script (Within Sandbox)
394+
395+
Each sandbox includes a `reset-sandbox.sh` script for convenience:
396+
397+
```bash
398+
# From within sandbox directory
399+
bash reset-sandbox.sh # Reset, remove config
400+
bash reset-sandbox.sh --preserve-config # Reset, keep config
401+
```
402+
366403
---
367404

368405
**Last Updated**: January 2025

0 commit comments

Comments
 (0)