Skip to content

Commit 1588c52

Browse files
committed
Add Watch Mode and Dry-Run features with documentation and integration tests
1 parent f13edd8 commit 1588c52

17 files changed

+5208
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,76 @@ A unified CLI tool for running CI/CD pipelines locally across GitHub Actions, Az
1818
- 🎯 Run specific jobs or steps
1919
- ✅ Validate pipeline syntax without execution
2020
- 🔍 Docker availability detection and diagnostics
21+
- 👀 **Watch Mode** for automatic re-execution on file changes
22+
- 🔬 **Dry-Run Mode** for pipeline validation without execution
23+
- 📝 **Structured Logging** with correlation IDs and secret masking
24+
- 🎛️ **Step Filtering** to run specific steps or skip slow ones
25+
26+
## Sprint 11 Features
27+
28+
Sprint 11 introduces four powerful new features for local development:
29+
30+
### Watch Mode
31+
32+
Automatically re-run pipelines when files change:
33+
34+
```bash
35+
# Watch and run on file changes
36+
pdk run --watch
37+
38+
# Watch with step filtering
39+
pdk run --watch --step "Build" --step "Test"
40+
```
41+
42+
See [Watch Mode Documentation](docs/watch-mode.md) for details.
43+
44+
### Dry-Run Mode
45+
46+
Validate pipelines without executing steps:
47+
48+
```bash
49+
# Validate pipeline
50+
pdk run --dry-run
51+
52+
# Get JSON output for CI integration
53+
pdk run --dry-run --output json
54+
```
55+
56+
See [Dry-Run Documentation](docs/dry-run.md) for details.
57+
58+
### Structured Logging
59+
60+
Comprehensive logging with correlation tracking and secret masking:
61+
62+
```bash
63+
# Verbose logging
64+
pdk run --verbose
65+
66+
# Maximum detail
67+
pdk run --trace
68+
69+
# Log to file
70+
pdk run --log-file pipeline.log
71+
```
72+
73+
See [Logging Documentation](docs/logging.md) for details.
74+
75+
### Step Filtering
76+
77+
Run specific steps or skip slow ones:
78+
79+
```bash
80+
# Run specific step
81+
pdk run --step "Build"
82+
83+
# Skip a step
84+
pdk run --skip-step "Deploy"
85+
86+
# Run specific job
87+
pdk run --job "test"
88+
```
89+
90+
See [Step Filtering Documentation](docs/step-filtering.md) for details.
2191

2292
## Getting Started
2393

@@ -249,11 +319,19 @@ Or use the convenience script:
249319
- Path resolution and wildcards
250320
- Full CLI integration and sample pipelines
251321

322+
- [x] **Sprint 11:** Polish & Integration
323+
- Watch Mode for automatic re-execution on file changes
324+
- Dry-Run Mode for pipeline validation
325+
- Structured Logging with correlation IDs and secret masking
326+
- Step Filtering for focused development
327+
- Comprehensive integration tests
328+
252329
### Planned
253330
- [ ] **Sprint 6:** GitLab CI support
254331
- [ ] **Sprint 7:** Configuration file support
255332
- [ ] **Sprint 8:** Advanced features (matrix builds)
256333
- [ ] **Sprint 9:** Artifact handling
334+
- [ ] **Sprint 12:** Performance optimizations and caching
257335

258336
## Contributing
259337

0 commit comments

Comments
 (0)