apunkt/flakestorm
1
0
Fork 0
mirror of https://github.com/flakestorm/flakestorm.git synced 2026-04-28 02:23:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update documentation and configuration for Flakestorm V2, enhancing clarity on CI processes, report generation, and reproducibility features. Added details on the new --output option for saving reports, clarified the use of --min-score, and improved descriptions of the seed configuration for deterministic runs. Updated README and usage guides to reflect these changes and ensure comprehensive understanding of the CI pipeline and report outputs.

Browse source
This commit is contained in:
Francisco M Humarang Jr. 2026-03-12 20:05:51 +08:00
parent 4a13425f8a
commit f4d45d4053
14 changed files with 356 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/API_SPECIFICATION.md
View file

@ -538,13 +538,24 @@ flakestorm replay export --from-report FILE # Export from an existing report
### V2: `flakestorm ci`
Run full CI pipeline: mutation run, contract run (if configured), chaos-only (if chaos configured), replay (if configured); then compute overall weighted score from `scoring.weights`.
Run full CI pipeline: mutation run, contract run (if configured), chaos-only (if chaos configured), replay (if configured); then compute overall weighted score from `scoring.weights`. Writes a **CI summary report** (e.g. `flakestorm-ci-report.html`) with per-phase scores and **"View detailed report"** links to phase-specific reports (mutation, contract, chaos, replay). Contract phase PASS/FAIL in the summary matches the contract detailed report (FAIL if any critical invariant fails).
```bash
flakestorm ci
flakestorm ci --config custom.yaml
flakestorm ci --min-score 0.5 # Fail if overall score below 0.5
flakestorm ci --output ./reports # Save summary + detailed reports to directory
flakestorm ci --output report.html # Save summary report to file
flakestorm ci --quiet # Minimal output, no progress bars
```
| Option | Description |
|--------|-------------|
| `--config`, `-c` | Config file path (default: `flakestorm.yaml`) |
| `--min-score` | Minimum overall (weighted) score to pass (default: 0.0) |
| `--output`, `-o` | Path to save reports: directory (creates `flakestorm-ci-report.html` + phase reports) or HTML file path |
| `--quiet`, `-q` | Minimal output, no progress bars |
---
## Environment Variables