First run quickstart (guided canonical path)¶
Use this page for a guided run of the same canonical first-proof lane.
If you only want the fastest proof with minimal text, use Blank repo to value in 60 seconds.
Guided run (5 minutes)¶
- Install in the target external repo (skip only if already installed):
python -m pip install "git+https://github.com/sherif69-sa/DevS69-sdetkit.git"
- (Optional) Verify CLI wiring:
python -m sdetkit --help
python -m sdetkit gate --help
- Run fast confidence gate:
python -m sdetkit gate fast --format json --stable-json --out build/gate-fast.json
- Run release gate:
python -m sdetkit gate release --format json --out build/release-preflight.json
- Run diagnostics:
python -m sdetkit doctor
Canonical artifact interpretation order¶
- Open
build/release-preflight.jsonfirst (ok,failed_steps,profile). - If
failed_stepsincludesgate_fast, openbuild/gate-fast.json(ok,failed_steps,profile). - Only then move to raw logs for deep debugging.
This order matches the canonical decoder: CI artifact walkthrough.
Optional wrappers (this repository only)¶
If you are inside this repository and prefer wrappers:
bash scripts/ready_to_use.sh quick
bash scripts/ready_to_use.sh release
External repositories should use direct python -m sdetkit ... commands.
Contract truth model for first-time external runs¶
gate fastandgate releasecan legitimately fail on first run while still generating trustworthy JSON triage artifacts.- Trust breaks only when artifacts are missing or malformed.
- Inspect
build/release-preflight.jsonandbuild/gate-fast.jsonbefore raw logs.
Next step routing¶
- Release-confidence model: Release confidence
- Team rollout: Adopt SDETKit in your repository
- Canonical CI flow: Recommended CI flow
- Evidence behavior: Before/after example, Evidence showcase