validate-checkpoint
npx machina-cli add skill hardness1020/VibeFlow/validate-checkpoint --openclawvalidate-checkpoint
Checkpoint validation and guardrail enforcement for the VibeFlow docs-first development workflow.
Purpose
This skill validates checkpoint completion before stage progression:
- Checks that required artifacts exist with all sections
- Enforces the docs-first mandate
- Runs validation scripts and reports pass/fail/warn status
- Returns structured JSON reports with blocking issues
Workflow
Validate Request
│
├── Determine checkpoint or document type
├── Locate required artifacts
└── Select validation script
│
▼
Run Validation
│
├── Execute validation checks
├── Collect errors and warnings
└── Generate JSON report
│
▼
Report Results
│
├── Output pass/fail summary
├── List blocking issues
└── Return exit code (0=pass, 1=fail, 2=warn)
Usage
Validate a Specific Checkpoint
/validate-checkpoint <number>
Example:
/validate-checkpoint 1
Validate Current State
/validate-checkpoint
This auto-detects the current stage and validates the appropriate checkpoint.
Validate Specific Document
/validate-checkpoint prd
/validate-checkpoint discovery <ID>
/validate-checkpoint spec <spec-name>
/validate-checkpoint feature <ID>
/validate-checkpoint opnote <ID>
Checkpoints
| # | Checkpoint | After Stage | Validates |
|---|---|---|---|
| 1 | Planning Complete | D | PRD, Discovery, SPECs, ADRs |
| 2 | Design Complete | E | FEATURE spec with API Design |
| 3 | Tests Complete | F | Failing unit tests with stubs |
| 4 | Implementation Complete | H | Passing tests, quality validation |
| 5 | Release Ready | J | OP-NOTE with all sections |
| 6 | Deployed | L | Deployment verified, indices updated |
Scripts
The following scripts are available in scripts/:
validate_checkpoint.py- Master validator, orchestrates all checkscheck_planning.py- Checkpoint #1: Planning phase validationcheck_design.py- Checkpoint #2: Design phase validationcheck_tests.py- Checkpoint #3: Test phase validationcheck_implementation.py- Checkpoint #4: Implementation validationcheck_release.py- Checkpoint #5: Release readiness validationcheck_deployed.py- Checkpoint #6: Deployment verification
Output Format
All validation scripts output JSON with this structure:
{
"checkpoint": 1,
"name": "Planning Complete",
"valid": false,
"issues": [
{
"severity": "error",
"file": "docs/prds/prd.md",
"message": "Missing required section: Success Metrics"
}
],
"warnings": [
{
"file": "docs/specs/spec-api.md",
"message": "Spec version not incremented despite contract changes"
}
],
"passed": 5,
"failed": 2,
"summary": "Checkpoint #1 NOT PASSED: 2 errors, 1 warning"
}
Exit Codes
0- All validations passed1- Validation failed (blocking issues found)2- Warnings only (can proceed with caution)
Manifest Update
After a checkpoint passes, update docs/workflow-state.yaml:
- Set
checkpointto the number that passed (e.g.,checkpoint: 2after CP#2 passes)
Stage advancement is handled by: /manage-work advance <ID>
References
See references/checkpoint-criteria.md for detailed validation criteria for each checkpoint.
Source
git clone https://github.com/hardness1020/VibeFlow/blob/main/.claude/skills/validate-checkpoint/SKILL.mdView on GitHub Overview
Validates checkpoint completion before stage progression, enforcing the docs-first mandate. It runs checks, collects errors and warnings, and returns a structured JSON report highlighting blocking issues.
How This Skill Works
Determine the target checkpoint or document type, locate required artifacts, and select the appropriate validation script. Then execute checks, gather errors and warnings, and emit a JSON report with an exit code (0=pass, 1=fail, 2=warn).
When to Use It
- Before advancing to the next stage to ensure artifacts exist and the docs-first mandate is enforced.
- When you want to auto-detect the current stage and validate the corresponding checkpoint.
- When validating a specific checkpoint by number (e.g., /validate-checkpoint 1).
- When validating a specific document type (prd, discovery, spec, feature, opnote).
- When you need a structured JSON report showing blocking issues and overall status.
Quick Start
- Step 1: Run the validator for the desired target (e.g., /validate-checkpoint or /validate-checkpoint 1 or /validate-checkpoint prd).
- Step 2: Review the JSON report for 'valid', 'issues', and 'warnings'; note the exit code.
- Step 3: If blocking issues exist, fix artifacts/docs and re-run; after success, advance docs-workflow-state accordingly.
Best Practices
- Ensure all required artifacts exist and include all sections before running validation.
- Run validations after any doc or artifact updates to avoid regressions.
- Integrate the validator into CI gates to block deployments with blocking issues.
- Prioritize blocking issues first; address warnings to improve overall quality.
- Treat exit codes as automated signals: 0 for pass, 1 for fail, 2 for warn.
Example Use Cases
- Run /validate-checkpoint 5 in CI to gate a release candidate once the OP-NOTE has all sections.
- Use /validate-checkpoint with no numbers to auto-detect the current stage and validate the appropriate checkpoint.
- Validate a PRD and its ADRs with /validate-checkpoint prd to ensure documentation readiness.
- Validate a specific discovery doc with /validate-checkpoint discovery 12 and inspect the JSON report.
- Validate API Design and Implementation artifacts (CP2/CP4) and capture the JSON report for posterity.